source4/lib/ldb/tools/ldbsearch.c

   1 /*
   2    ldb database library
   3
   4    Copyright (C) Andrew Tridgell  2004
   5
   6      ** NOTE! The following LGPL license applies to the ldb
   7      ** library. This does NOT imply that all of Samba is released
   8      ** under the LGPL
   9
  10    This library is free software; you can redistribute it and/or
  11    modify it under the terms of the GNU Lesser General Public
  12    License as published by the Free Software Foundation; either
  13    version 3 of the License, or (at your option) any later version.
  14
  15    This library is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18    Lesser General Public License for more details.
  19
  20    You should have received a copy of the GNU Lesser General Public
  21    License along with this library; if not, see <http://www.gnu.org/licenses/>.
  22 */
  23
  24 /*
  25  *  Name: ldb
  26  *
  27  *  Component: ldbsearch
  28  *
  29  *  Description: utility for ldb search - modelled on ldapsearch
  30  *
  31  *  Author: Andrew Tridgell
  32  */
  33
  34 #include "ldb_includes.h"
  35 #include "ldb.h"
  36 #include "tools/cmdline.h"
  37
  38 static void usage(void)
  39 {
  40         printf("Usage: ldbsearch <options> <expression> <attrs...>\n");
  41         printf("Options:\n");
  42         printf("  -H ldb_url       choose the database (or $LDB_URL)\n");
  43         printf("  -s base|sub|one  choose search scope\n");
  44         printf("  -b basedn        choose baseDN\n");
  45         printf("  -i               read search expressions from stdin\n");
  46         printf("  -S               sort returned attributes\n");
  47         printf("  -o options       pass options like modules to activate\n");
  48         printf("              e.g: -o modules:timestamps\n");
  49         exit(1);
  50 }
  51
  52 static int do_compare_msg(struct ldb_message **el1,
  53                           struct ldb_message **el2,
  54                           void *opaque)
  55 {
  56         return ldb_dn_compare((*el1)->dn, (*el2)->dn);
  57 }
  58
  59 struct search_context {
  60         struct ldb_context *ldb;
  61         struct ldb_control **req_ctrls;
  62
  63         int sort;
  64         int num_stored;
  65         struct ldb_message **store;
  66         int refs_stored;
  67         char **refs_store;
  68
  69         int entries;
  70         int refs;
  71
  72         int pending;
  73         int status;
  74 };
  75
  76 static int store_message(struct ldb_message *msg, struct search_context *sctx) {
  77
  78         sctx->store = talloc_realloc(sctx, sctx->store, struct ldb_message *, sctx->num_stored + 2);
  79         if (!sctx->store) {
  80                 fprintf(stderr, "talloc_realloc failed while storing messages\n");
  81                 return -1;
  82         }
  83
  84         sctx->store[sctx->num_stored] = talloc_move(sctx->store, &msg);
  85         sctx->num_stored++;
  86         sctx->store[sctx->num_stored] = NULL;
  87
  88         return 0;
  89 }
  90
  91 static int store_referral(char *referral, struct search_context *sctx) {
  92
  93         sctx->refs_store = talloc_realloc(sctx, sctx->refs_store, char *, sctx->refs_stored + 2);
  94         if (!sctx->refs_store) {
  95                 fprintf(stderr, "talloc_realloc failed while storing referrals\n");
  96                 return -1;
  97         }
  98
  99         sctx->refs_store[sctx->refs_stored] = talloc_move(sctx->refs_store, &referral);
 100         sctx->refs_stored++;
 101         sctx->refs_store[sctx->refs_stored] = NULL;
 102
 103         return 0;
 104 }
 105
 106 static int display_message(struct ldb_message *msg, struct search_context *sctx) {
 107         struct ldb_ldif ldif;
 108
 109         sctx->entries++;
 110         printf("# record %d\n", sctx->entries);
 111
 112         ldif.changetype = LDB_CHANGETYPE_NONE;
 113         ldif.msg = msg;
 114
 115         if (sctx->sort) {
 116         /*
 117          * Ensure attributes are always returned in the same
 118          * order.  For testing, this makes comparison of old
 119          * vs. new much easier.
 120          */
 121                 ldb_msg_sort_elements(ldif.msg);
 122         }
 123
 124         ldb_ldif_write_file(sctx->ldb, stdout, &ldif);
 125
 126         return 0;
 127 }
 128
 129 static int display_referral(char *referral, struct search_context *sctx)
 130 {
 131
 132         sctx->refs++;
 133         printf("# Referral\nref: %s\n\n", referral);
 134
 135         return 0;
 136 }
 137
 138 static int search_callback(struct ldb_request *req, struct ldb_reply *ares)
 139 {
 140         struct search_context *sctx;
 141         int ret;
 142
 143         sctx = talloc_get_type(req->context, struct search_context);
 144
 145         if (!ares) {
 146                 return ldb_request_done(req, LDB_ERR_OPERATIONS_ERROR);
 147         }
 148         if (ares->error != LDB_SUCCESS) {
 149                 return ldb_request_done(req, ares->error);
 150         }
 151
 152         switch (ares->type) {
 153         case LDB_REPLY_ENTRY:
 154                 if (sctx->sort) {
 155                         ret = store_message(ares->message, sctx);
 156                 } else {
 157                         ret = display_message(ares->message, sctx);
 158                 }
 159                 break;
 160
 161         case LDB_REPLY_REFERRAL:
 162                 if (sctx->sort) {
 163                         ret = store_referral(ares->referral, sctx);
 164                 } else {
 165                         ret = display_referral(ares->referral, sctx);
 166                 }
 167                 if (ret) {
 168                         return ldb_request_done(req, LDB_ERR_OPERATIONS_ERROR);
 169                 }
 170                 break;
 171
 172         case LDB_REPLY_DONE:
 173                 if (ares->controls) {
 174                         if (handle_controls_reply(ares->controls, sctx->req_ctrls) == 1)
 175                                 sctx->pending = 1;
 176                 }
 177                 talloc_free(ares);
 178                 return ldb_request_done(req, LDB_SUCCESS);
 179         }
 180
 181         talloc_free(ares);
 182         if (ret) {
 183                 return ldb_request_done(req, LDB_ERR_OPERATIONS_ERROR);
 184         }
 185
 186         return LDB_SUCCESS;
 187 }
 188
 189 static int do_search(struct ldb_context *ldb,
 190                      struct ldb_dn *basedn,
 191                      struct ldb_cmdline *options,
 192                      const char *expression,
 193                      const char * const *attrs)
 194 {
 195         struct ldb_request *req;
 196         struct search_context *sctx;
 197         int ret;
 198
 199         req = NULL;
 200
 201         sctx = talloc(ldb, struct search_context);
 202         if (!sctx) return -1;
 203
 204         sctx->ldb = ldb;
 205         sctx->sort = options->sorted;
 206         sctx->num_stored = 0;
 207         sctx->refs_stored = 0;
 208         sctx->store = NULL;
 209         sctx->req_ctrls = ldb_parse_control_strings(ldb, sctx, (const char **)options->controls);
 210         if (options->controls != NULL &&  sctx->req_ctrls== NULL) {
 211                 printf("parsing controls failed: %s\n", ldb_errstring(ldb));
 212                 return -1;
 213         }
 214         sctx->entries = 0;
 215         sctx->refs = 0;
 216
 217         if (basedn == NULL) {
 218                 basedn = ldb_get_default_basedn(ldb);
 219         }
 220
 221 again:
 222         /* free any previous requests */
 223         if (req) talloc_free(req);
 224
 225         ret = ldb_build_search_req(&req, ldb, ldb,
 226                                    basedn, options->scope,
 227                                    expression, attrs,
 228                                    sctx->req_ctrls,
 229                                    sctx, search_callback,
 230                                    NULL);
 231         if (ret != LDB_SUCCESS) {
 232                 talloc_free(sctx);
 233                 printf("allocating request failed: %s\n", ldb_errstring(ldb));
 234                 return -1;
 235         }
 236
 237         sctx->pending = 0;
 238
 239         ret = ldb_request(ldb, req);
 240         if (ret != LDB_SUCCESS) {
 241                 printf("search failed - %s\n", ldb_errstring(ldb));
 242                 return -1;
 243         }
 244
 245         ret = ldb_wait(req->handle, LDB_WAIT_ALL);
 246         if (ret != LDB_SUCCESS) {
 247                 printf("search error - %s\n", ldb_errstring(ldb));
 248                 return -1;
 249         }
 250
 251         if (sctx->pending)
 252                 goto again;
 253
 254         if (sctx->sort && (sctx->num_stored != 0 || sctx->refs != 0)) {
 255                 int i;
 256
 257                 if (sctx->num_stored) {
 258                         ldb_qsort(sctx->store, sctx->num_stored, sizeof(struct ldb_message *),
 259                                   ldb, (ldb_qsort_cmp_fn_t)do_compare_msg);
 260                 }
 261                 for (i = 0; i < sctx->num_stored; i++) {
 262                         display_message(sctx->store[i], sctx);
 263                 }
 264
 265                 for (i = 0; i < sctx->refs_stored; i++) {
 266                         display_referral(sctx->refs_store[i], sctx);
 267                 }
 268         }
 269
 270         printf("# returned %d records\n# %d entries\n# %d referrals\n",
 271                 sctx->entries + sctx->refs, sctx->entries, sctx->refs);
 272
 273         talloc_free(sctx);
 274         talloc_free(req);
 275
 276         return 0;
 277 }
 278
 279 int main(int argc, const char **argv)
 280 {
 281         struct ldb_context *ldb;
 282         struct ldb_dn *basedn = NULL;
 283         const char * const * attrs = NULL;
 284         struct ldb_cmdline *options;
 285         int ret = -1;
 286         const char *expression = "(|(objectClass=*)(distinguishedName=*))";
 287
 288         ldb = ldb_init(NULL, NULL);
 289         if (ldb == NULL) {
 290                 return -1;
 291         }
 292
 293         options = ldb_cmdline_process(ldb, argc, argv, usage);
 294
 295         /* the check for '=' is for compatibility with ldapsearch */
 296         if (!options->interactive &&
 297             options->argc > 0 &&
 298             strchr(options->argv[0], '=')) {
 299                 expression = options->argv[0];
 300                 options->argv++;
 301                 options->argc--;
 302         }
 303
 304         if (options->argc > 0) {
 305                 attrs = (const char * const *)(options->argv);
 306         }
 307
 308         if (options->basedn != NULL) {
 309                 basedn = ldb_dn_new(ldb, ldb, options->basedn);
 310                 if ( ! ldb_dn_validate(basedn)) {
 311                         fprintf(stderr, "Invalid Base DN format\n");
 312                         exit(1);
 313                 }
 314         }
 315
 316         if (options->interactive) {
 317                 char line[1024];
 318                 while (fgets(line, sizeof(line), stdin)) {
 319                         if (do_search(ldb, basedn, options, line, attrs) == -1) {
 320                                 ret = -1;
 321                         }
 322                 }
 323         } else {
 324                 ret = do_search(ldb, basedn, options, expression, attrs);
 325         }
 326
 327         talloc_free(ldb);
 328         return ret;
 329 }