Fix segfault when sorting LDAP replies on the client.
[samba.git] / source4 / lib / ldb / tools / ldbsearch.c
index f764b2855794e4f8f73e490139aa1668d3d1f08f..dba0549b4445e15c8e0f2a37cf97cc2ca4e7cb18 100644 (file)
@@ -10,7 +10,7 @@
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
-   version 2 of the License, or (at your option) any later version.
+   version 3 of the License, or (at your option) any later version.
 
    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ -18,8 +18,7 @@
    Lesser General Public License for more details.
 
    You should have received a copy of the GNU Lesser General Public
-   License along with this library; if not, write to the Free Software
-   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+   License along with this library; if not, see <http://www.gnu.org/licenses/>.
 */
 
 /*
  *  Author: Andrew Tridgell
  */
 
-#include "includes.h"
-#include "ldb/include/ldb.h"
-#include "ldb/include/ldb_private.h"
-
-#ifdef _SAMBA_BUILD_
-#include "system/filesys.h"
-#endif
+#include "ldb_includes.h"
+#include "tools/cmdline.h"
 
 static void usage(void)
 {
@@ -48,134 +42,280 @@ static void usage(void)
        printf("  -s base|sub|one  choose search scope\n");
        printf("  -b basedn        choose baseDN\n");
        printf("  -i               read search expressions from stdin\n");
+        printf("  -S               sort returned attributes\n");
        printf("  -o options       pass options like modules to activate\n");
        printf("              e.g: -o modules:timestamps\n");
        exit(1);
 }
 
+static int do_compare_msg(struct ldb_message **el1,
+                         struct ldb_message **el2,
+                         void *opaque)
+{
+       return ldb_dn_compare((*el1)->dn, (*el2)->dn);
+}
+
+struct search_context {
+       struct ldb_control **req_ctrls;
+
+       int sort;
+       int num_stored;
+       struct ldb_message **store;
+       char **refs_store;
+
+       int entries;
+       int refs;
+
+       int pending;
+       int status;
+};
+
+static int store_message(struct ldb_message *msg, struct search_context *sctx) {
+
+       sctx->store = talloc_realloc(sctx, sctx->store, struct ldb_message *, sctx->num_stored + 2);
+       if (!sctx->store) {
+               fprintf(stderr, "talloc_realloc failed while storing messages\n");
+               return -1;
+       }
+
+       sctx->store[sctx->num_stored] = talloc_move(sctx->store, &msg);
+       sctx->num_stored++;
+       sctx->store[sctx->num_stored] = NULL;
+
+       return 0;
+}
+
+static int store_referral(char *referral, struct search_context *sctx) {
+
+       sctx->refs_store = talloc_realloc(sctx, sctx->refs_store, char *, sctx->refs + 2);
+       if (!sctx->refs_store) {
+               fprintf(stderr, "talloc_realloc failed while storing referrals\n");
+               return -1;
+       }
+
+       sctx->refs_store[sctx->refs] = talloc_move(sctx->refs_store, &referral);
+       sctx->refs++;
+       sctx->refs_store[sctx->refs] = NULL;
+
+       return 0;
+}
+
+static int display_message(struct ldb_context *ldb, struct ldb_message *msg, struct search_context *sctx) {
+       struct ldb_ldif ldif;
+
+       sctx->entries++;
+       printf("# record %d\n", sctx->entries);
+
+       ldif.changetype = LDB_CHANGETYPE_NONE;
+       ldif.msg = msg;
+
+               if (sctx->sort) {
+       /*
+        * Ensure attributes are always returned in the same
+        * order.  For testing, this makes comparison of old
+        * vs. new much easier.
+        */
+               ldb_msg_sort_elements(ldif.msg);
+               }
+
+       ldb_ldif_write_file(ldb, stdout, &ldif);
+
+       return 0;
+}
+
+static int display_referral(char *referral, struct search_context *sctx)
+{
+
+       sctx->refs++;
+       printf("# Referral\nref: %s\n\n", referral);
+
+       return 0;
+}
+
+static int search_callback(struct ldb_context *ldb, void *context, struct ldb_reply *ares)
+{
+       struct search_context *sctx = talloc_get_type(context, struct search_context);
+       int ret;
+       
+       switch (ares->type) {
+
+       case LDB_REPLY_ENTRY:
+               if (sctx->sort) {
+                       ret = store_message(ares->message, sctx);
+               } else {
+                       ret = display_message(ldb, ares->message, sctx);
+               }
+               break;
+
+       case LDB_REPLY_REFERRAL:
+               if (sctx->sort) {
+                       ret = store_referral(ares->referral, sctx);
+               } else {
+                       ret = display_referral(ares->referral, sctx);
+               }
+               break;
+
+       case LDB_REPLY_DONE:
+               if (ares->controls) {
+                       if (handle_controls_reply(ares->controls, sctx->req_ctrls) == 1)
+                               sctx->pending = 1;
+               }
+               ret = 0;
+               break;
+               
+       default:
+               fprintf(stderr, "unknown Reply Type\n");
+               return LDB_ERR_OTHER;
+       }
+
+       if (talloc_free(ares) == -1) {
+               fprintf(stderr, "talloc_free failed\n");
+               sctx->pending = 0;
+               return LDB_ERR_OPERATIONS_ERROR;
+       }
+
+       if (ret) {
+               return LDB_ERR_OPERATIONS_ERROR;
+       }
+
+       return LDB_SUCCESS;
+}
+
 static int do_search(struct ldb_context *ldb,
-                    const char *basedn,
-                    int scope,
+                    struct ldb_dn *basedn,
+                    struct ldb_cmdline *options,
                     const char *expression,
                     const char * const *attrs)
 {
-       int ret, i;
-       struct ldb_message **msgs;
+       struct ldb_request *req;
+       struct search_context *sctx;
+       int ret;
+
+       req = talloc(ldb, struct ldb_request);
+       if (!req) return -1;
+       
+       sctx = talloc(req, struct search_context);
+       if (!sctx) return -1;
+
+       sctx->sort = options->sorted;
+       sctx->num_stored = 0;
+       sctx->store = NULL;
+       sctx->req_ctrls = ldb_parse_control_strings(ldb, sctx, (const char **)options->controls);
+       if (options->controls != NULL &&  sctx->req_ctrls== NULL) {
+               printf("parsing controls failed: %s\n", ldb_errstring(ldb));
+               return -1;
+       }
+       sctx->entries = 0;
+       sctx->refs = 0;
+
+       if (basedn == NULL) {
+               basedn = ldb_get_default_basedn(ldb);
+       }
 
-       ret = ldb_search(ldb, basedn, scope, expression, attrs, &msgs);
-       if (ret == -1) {
+       req->operation = LDB_SEARCH;
+       req->op.search.base = basedn;
+       req->op.search.scope = options->scope;
+       req->op.search.tree = ldb_parse_tree(req, expression);
+       if (req->op.search.tree == NULL) return -1;
+       req->op.search.attrs = attrs;
+       req->controls = sctx->req_ctrls;
+       req->context = sctx;
+       req->callback = &search_callback;
+       ldb_set_timeout(ldb, req, 0); /* TODO: make this settable by command line */
+
+again:
+       sctx->pending = 0;
+
+       ret = ldb_request(ldb, req);
+       if (ret != LDB_SUCCESS) {
                printf("search failed - %s\n", ldb_errstring(ldb));
                return -1;
        }
 
-       printf("# returned %d records\n", ret);
+       ret = ldb_wait(req->handle, LDB_WAIT_ALL);
+               if (ret != LDB_SUCCESS) {
+               printf("search error - %s\n", ldb_errstring(ldb));
+               return -1;
+       }
 
-       for (i=0;i<ret;i++) {
-               struct ldb_ldif ldif;
-               printf("# record %d\n", i+1);
+       if (sctx->pending)
+               goto again;
 
-               ldif.changetype = LDB_CHANGETYPE_NONE;
-               ldif.msg = msgs[i];
+       if (sctx->sort && (sctx->num_stored != 0 || sctx->refs != 0)) {
+               int i;
 
-               ldb_ldif_write_file(ldb, stdout, &ldif);
-       }
+               ldb_qsort(sctx->store, sctx->num_stored, sizeof(struct ldb_message *),
+                         ldb, (ldb_qsort_cmp_fn_t)do_compare_msg);
 
-       if (ret > 0) {
-               ret = ldb_search_free(ldb, msgs);
-               if (ret == -1) {
-                       fprintf(stderr, "search_free failed\n");
+               if (ret != 0) {
+                       fprintf(stderr, "An error occurred while sorting messages\n");
                        exit(1);
                }
+
+               for (i = 0; i < sctx->num_stored; i++) {
+                       display_message(ldb, sctx->store[i], sctx);
+               }
+
+               for (i = 0; i < sctx->refs; i++) {
+                       display_referral(sctx->refs_store[i], sctx);
+               }
        }
 
+       printf("# returned %d records\n# %d entries\n# %d referrals\n",
+               sctx->entries + sctx->refs, sctx->entries, sctx->refs);
+
+       talloc_free(req);
+
        return 0;
 }
 
- int main(int argc, char * const argv[])
+int main(int argc, const char **argv)
 {
        struct ldb_context *ldb;
+       struct ldb_dn *basedn = NULL;
        const char * const * attrs = NULL;
-       const char *ldb_url;
-       const char *basedn = NULL;
-       const char **options = NULL;
-       int opt, ldbopts;
-       enum ldb_scope scope = LDB_SCOPE_SUBTREE;
-       int interactive = 0, ret=0;
-
-       ldb_url = getenv("LDB_URL");
-
-       ldbopts = 0;
-       while ((opt = getopt(argc, argv, "b:H:s:o:hi")) != EOF) {
-               switch (opt) {
-               case 'b':
-                       basedn = optarg;
-                       break;
-
-               case 'H':
-                       ldb_url = optarg;
-                       break;
-
-               case 's':
-                       if (strcmp(optarg, "base") == 0) {
-                               scope = LDB_SCOPE_BASE;
-                       } else if (strcmp(optarg, "sub") == 0) {
-                               scope = LDB_SCOPE_SUBTREE;
-                       } else if (strcmp(optarg, "one") == 0) {
-                               scope = LDB_SCOPE_ONELEVEL;
-                       }
-                       break;
+       struct ldb_cmdline *options;
+       int ret = -1;
+       const char *expression = "(|(objectClass=*)(distinguishedName=*))";
 
-               case 'i':
-                       interactive = 1;
-                       break;
+       ldb_global_init();
 
-               case 'o':
-                       options = ldb_options_parse(options, &ldbopts, optarg);
-                       break;
+       ldb = ldb_init(NULL);
 
-               case 'h':
-               default:
-                       usage();
-                       break;
-               }
-       }
+       options = ldb_cmdline_process(ldb, argc, argv, usage);
 
-       if (!ldb_url) {
-               fprintf(stderr, "You must specify a ldb URL\n\n");
-               usage();
+       /* the check for '=' is for compatibility with ldapsearch */
+       if (!options->interactive &&
+           options->argc > 0 && 
+           strchr(options->argv[0], '=')) {
+               expression = options->argv[0];
+               options->argv++;
+               options->argc--;
        }
 
-       argc -= optind;
-       argv += optind;
-
-       if (argc < 1 && !interactive) {
-               usage();
-               exit(1);
+       if (options->argc > 0) {
+               attrs = (const char * const *)(options->argv);
        }
 
-       if (argc > 1) {
-               attrs = (const char * const *)(argv+1);
-       }
-
-       ldb = ldb_connect(ldb_url, LDB_FLG_RDONLY, options);
-       if (!ldb) {
-               perror("ldb_connect");
-               exit(1);
+       if (options->basedn != NULL) {
+               basedn = ldb_dn_new(ldb, ldb, options->basedn);
+               if ( ! ldb_dn_validate(basedn)) {
+                       fprintf(stderr, "Invalid Base DN format\n");
+                       exit(1);
+               }
        }
 
-       ldb_set_debug_stderr(ldb);
-
-       if (interactive) {
+       if (options->interactive) {
                char line[1024];
                while (fgets(line, sizeof(line), stdin)) {
-                       if (do_search(ldb, basedn, scope, line, attrs) == -1) {
+                       if (do_search(ldb, basedn, options, line, attrs) == -1) {
                                ret = -1;
                        }
                }
        } else {
-               ret = do_search(ldb, basedn, scope, argv[0], attrs);
+               ret = do_search(ldb, basedn, options, expression, attrs);
        }
 
-       ldb_close(ldb);
+       talloc_free(ldb);
        return ret;
 }