1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2012 Index Data
3 * See the file LICENSE for details.
6 \brief ZOOM C command line tool (shell)
15 #include <yaz/wrbuf.h>
17 #include <yaz/options.h>
19 #if HAVE_READLINE_READLINE_H
20 #include <readline/readline.h>
22 #if HAVE_READLINE_HISTORY_H
23 #include <readline/history.h>
31 static void process_events(ZOOM_connection *c)
35 yaz_log(YLOG_DEBUG, "process_events");
36 while ((i = ZOOM_event(MAX_CON, c)) != 0)
38 int peek = ZOOM_connection_peek_event(c[i-1]);
39 int event = ZOOM_connection_last_event(c[i-1]);
40 yaz_log(YLOG_DEBUG, "no = %d peek = %d event = %d %s", i-1,
43 ZOOM_get_event_str(event));
47 static int next_token_chars(const char **cpp, const char **t_start,
48 const char *tok_chars)
51 const char *cp = *cpp;
58 while (*cp && *cp != '"')
69 while (*cp && !strchr(tok_chars, *cp))
78 return len; /* return -1 if no token was read .. */
81 static int next_token(const char **cpp, const char **t_start)
83 return next_token_chars(cpp, t_start, "\r\n ");
87 static WRBUF next_token_new_wrbuf(const char **cpp)
91 int len = next_token(cpp, &start);
96 wrbuf_write(w, start, len);
100 static int is_command(const char *cmd_str, const char *this_str, int this_len)
102 int cmd_len = strlen(cmd_str);
103 if (cmd_len != this_len)
105 if (memcmp(cmd_str, this_str, cmd_len))
110 static int cmd_set(ZOOM_connection *c, ZOOM_resultset *r,
111 ZOOM_options options,
118 if (!(key = next_token_new_wrbuf(args)))
120 printf("missing argument for set\n");
123 val_len = next_token_chars(args, &val_buf, "");
125 ZOOM_options_setl(options, wrbuf_cstr(key), val_buf, val_len);
127 ZOOM_options_set(options, wrbuf_cstr(key), 0);
132 static int cmd_get(ZOOM_connection *c, ZOOM_resultset *r,
133 ZOOM_options options,
137 if (!(key = next_token_new_wrbuf(args)))
139 printf("missing argument for get\n");
144 const char *val = ZOOM_options_get(options, wrbuf_cstr(key));
145 printf("%s = %s\n", wrbuf_cstr(key), val ? val : "<null>");
151 static int cmd_rget(ZOOM_connection *c, ZOOM_resultset *r,
152 ZOOM_options options,
156 if (!(key = next_token_new_wrbuf(args)))
158 printf("missing argument for get\n");
164 for (i = 0; i<MAX_CON; i++)
170 val = ZOOM_resultset_option_get(r[i], wrbuf_cstr(key));
171 printf("%s = %s\n", wrbuf_cstr(key), val ? val : "<null>");
178 static int cmd_close(ZOOM_connection *c, ZOOM_resultset *r,
179 ZOOM_options options,
184 host = next_token_new_wrbuf(args);
185 for (i = 0; i<MAX_CON; i++)
192 ZOOM_connection_destroy(c[i]);
195 else if ((h = ZOOM_connection_option_get(c[i], "host"))
196 && !strcmp(h, wrbuf_cstr(host)))
198 ZOOM_connection_destroy(c[i]);
207 static void display_records(ZOOM_connection c,
209 size_t start, size_t count, const char *type)
212 for (i = 0; i < count; i++)
214 size_t pos = i + start;
215 ZOOM_record rec = ZOOM_resultset_record(r, pos);
216 const char *db = ZOOM_record_get(rec, "database", 0);
218 if (ZOOM_record_error(rec, 0, 0, 0))
223 int error = ZOOM_record_error(rec, &msg, &addinfo, &diagset);
225 printf("%lld %s: %s (%s:%d) %s\n", (long long) pos,
226 (db ? db : "unknown"),
227 msg, diagset, error, addinfo ? addinfo : "none");
232 const char *render = ZOOM_record_get(rec, type, &len);
233 const char *syntax = ZOOM_record_get(rec, "syntax", 0);
234 const char *schema = ZOOM_record_get(rec, "schema", 0);
235 /* if rec is non-null, we got a record for display */
238 printf("%lld database=%s syntax=%s schema=%s\n",
239 (long long) pos, (db ? db : "unknown"), syntax,
240 schema ? schema : "unknown");
243 if (fwrite(render, 1, len, stdout) != (size_t) len)
245 printf("write to stdout failed\n");
254 static int cmd_show(ZOOM_connection *c, ZOOM_resultset *r,
255 ZOOM_options options,
259 size_t start = 0, count = 1;
260 const char *type = "render";
261 WRBUF render_str = 0;
267 if ((tmp = next_token_new_wrbuf(args)))
269 start = atoi(wrbuf_cstr(tmp));
273 if ((tmp = next_token_new_wrbuf(args)))
275 count = atoi(wrbuf_cstr(tmp));
278 render_str = next_token_new_wrbuf(args);
281 type = wrbuf_cstr(render_str);
283 for (i = 0; i < MAX_CON; i++)
284 ZOOM_resultset_records(r[i], 0, start, count);
287 for (i = 0; i < MAX_CON; i++)
290 const char *errmsg, *addinfo, *dset;
291 /* display errors if any */
294 if ((error = ZOOM_connection_error_x(c[i], &errmsg, &addinfo, &dset)))
296 printf("%s error: %s (%s:%d) %s\n",
297 ZOOM_connection_option_get(c[i], "host"), errmsg,
298 dset, error, addinfo);
303 /* OK, no major errors. Display records... */
304 display_records(c[i], r[i], start, count, type);
308 wrbuf_destroy(render_str);
312 static void display_facets(ZOOM_facet_field *facets, int count) {
314 printf("Facets: \n");
315 for (index = 0; index < count; index++) {
317 const char *facet_name = ZOOM_facet_field_name(facets[index]);
318 printf(" %s: \n", facet_name);
319 for (term_index = 0; term_index < ZOOM_facet_field_term_count(facets[index]); term_index++) {
321 const char *term = ZOOM_facet_field_get_term(facets[index], term_index, &freq);
322 printf(" %s(%d) \n", term, freq);
327 static int cmd_facets(ZOOM_connection *c, ZOOM_resultset *r,
328 ZOOM_options options,
336 for (i = 0; i < MAX_CON; i++)
339 const char *errmsg, *addinfo, *dset;
340 /* display errors if any */
343 if ((error = ZOOM_connection_error_x(c[i], &errmsg, &addinfo, &dset)))
345 printf("%s error: %s (%s:%d) %s\n",
346 ZOOM_connection_option_get(c[i], "host"), errmsg,
347 dset, error, addinfo);
352 int num_facets = ZOOM_resultset_facets_size(r[i]);
354 ZOOM_facet_field *facets = ZOOM_resultset_facets(r[i]);
355 display_facets(facets, num_facets);
362 static int cmd_suggestions(ZOOM_connection *c, ZOOM_resultset *r, ZOOM_options options, const char **args)
369 for (i = 0; i < MAX_CON; i++)
372 const char *errmsg, *addinfo, *dset;
373 /* display errors if any */
376 if ((error = ZOOM_connection_error_x(c[i], &errmsg, &addinfo, &dset)))
378 printf("%s error: %s (%s:%d) %s\n",
379 ZOOM_connection_option_get(c[i], "host"), errmsg,
380 dset, error, addinfo);
385 const char *suggestions = ZOOM_resultset_option_get(r[i], "suggestions");
387 printf("Suggestions: \n%s\n", suggestions);
395 static int cmd_ext(ZOOM_connection *c, ZOOM_resultset *r,
396 ZOOM_options options,
399 ZOOM_package p[MAX_CON];
402 WRBUF ext_type_str = next_token_new_wrbuf(args);
406 printf("es: missing type "
407 "(itemorder, create, drop, commit, update, xmlupdate)\n");
410 for (i = 0; i<MAX_CON; i++)
414 p[i] = ZOOM_connection_package(c[i], 0);
415 ZOOM_package_send(p[i], ext_type_str ? wrbuf_cstr(ext_type_str):0);
423 for (i = 0; i<MAX_CON; i++)
426 const char *errmsg, *addinfo, *dset;
427 /* display errors if any */
430 if ((error = ZOOM_connection_error_x(c[i], &errmsg, &addinfo, &dset)))
432 printf("%s error: %s (%s:%d) %s\n",
433 ZOOM_connection_option_get(c[i], "host"), errmsg,
434 dset, error, addinfo);
441 v = ZOOM_package_option_get(p[i], "targetReference");
443 printf("targetReference: %s\n", v);
444 v = ZOOM_package_option_get(p[i], "xmlUpdateDoc");
446 printf("xmlUpdateDoc: %s\n", v);
448 ZOOM_package_destroy(p[i]);
451 wrbuf_destroy(ext_type_str);
455 static int cmd_debug(ZOOM_connection *c, ZOOM_resultset *r,
456 ZOOM_options options,
459 yaz_log_init_level(YLOG_ALL);
463 static int cmd_search(ZOOM_connection *c, ZOOM_resultset *r,
464 ZOOM_options options,
468 const char *query_str = *args;
472 s = ZOOM_query_create();
473 while (*query_str == ' ')
475 if (memcmp(query_str, "cql:", 4) == 0)
477 ZOOM_query_cql(s, query_str + 4);
479 else if (ZOOM_query_prefix(s, query_str))
481 printf("Bad PQF: %s\n", query_str);
482 ZOOM_query_destroy(s);
485 for (i = 0; i<MAX_CON; i++)
490 ZOOM_resultset_destroy(r[i]);
494 r[i] = ZOOM_connection_search(c[i], s);
496 ZOOM_query_destroy(s);
500 for (i = 0; i<MAX_CON; i++)
503 const char *errmsg, *addinfo, *dset;
504 /* display errors if any */
507 if ((error = ZOOM_connection_error_x(c[i], &errmsg, &addinfo, &dset)))
509 printf("%s error: %s (%s:%d) %s\n",
510 ZOOM_connection_option_get(c[i], "host"), errmsg,
511 dset, error, addinfo);
516 /* OK, no major errors. Look at the result count */
517 int start = ZOOM_options_get_int(options, "start", 0);
518 int count = ZOOM_options_get_int(options, "count", 0);
521 printf("%s: %lld hits\n", ZOOM_connection_option_get(c[i], "host"),
522 (long long int) ZOOM_resultset_size(r[i]));
524 facet_num = ZOOM_resultset_facets_size(r[i]);
527 ZOOM_facet_field *facets = ZOOM_resultset_facets(r[i]);
529 for (facet_idx = 0; facet_idx < facet_num; facet_idx++)
531 const char *name = ZOOM_facet_field_name(facets[facet_idx]);
533 size_t term_num = ZOOM_facet_field_term_count(facets[facet_idx]);
534 printf("facet: %s\n", name);
535 for (term_idx = 0; term_idx < term_num; term_idx++ )
539 ZOOM_facet_field_get_term(facets[facet_idx], term_idx, &freq);
540 printf("term: %s %d\n", term, freq);
545 display_records(c[i], r[i], start, count, "render");
551 static int cmd_scan(ZOOM_connection *c, ZOOM_resultset *r,
552 ZOOM_options options,
555 const char *query_str = *args;
556 ZOOM_query query = ZOOM_query_create();
559 ZOOM_scanset s[MAX_CON];
561 while (*query_str == ' ')
564 if (memcmp(query_str, "cql:", 4) == 0)
566 ZOOM_query_cql(query, query_str + 4);
568 else if (ZOOM_query_prefix(query, query_str))
570 printf("Bad PQF: %s\n", query_str);
571 ZOOM_query_destroy(query);
575 for (i = 0; i<MAX_CON; i++)
578 s[i] = ZOOM_connection_scan1(c[i], query);
582 ZOOM_query_destroy(query);
586 for (i = 0; i<MAX_CON; i++)
589 const char *errmsg, *addinfo, *dset;
590 /* display errors if any */
593 if ((error = ZOOM_connection_error_x(c[i], &errmsg, &addinfo, &dset)))
595 printf("%s error: %s (%s:%d) %s\n",
596 ZOOM_connection_option_get(c[i], "host"), errmsg,
597 dset, error, addinfo);
602 size_t p, sz = ZOOM_scanset_size(s[i]);
603 for (p = 0; p < sz; p++)
607 const char *term = ZOOM_scanset_display_term(s[i], p,
609 printf("%.*s %lld\n", (int) len, term, (long long int) occ);
611 ZOOM_scanset_destroy(s[i]);
617 static int cmd_sort(ZOOM_connection *c, ZOOM_resultset *r,
618 ZOOM_options options,
621 const char *sort_spec = *args;
625 while (*sort_spec == ' ')
628 for (i = 0; i<MAX_CON; i++)
631 ZOOM_resultset_sort(r[i], "yaz", sort_spec);
637 static int cmd_help(ZOOM_connection *c, ZOOM_resultset *r,
638 ZOOM_options options,
641 printf("connect <zurl>\n");
642 printf("search <pqf>\n");
643 printf("show [<start> [<count> [<type]]]\n");
645 printf("scan <term>\n");
647 printf("close <zurl>\n");
648 printf("ext <type>\n");
649 printf("set <option> [<value>]\n");
650 printf("get <option>\n");
652 printf("options:\n");
655 printf(" databaseName\n");
656 printf(" preferredRecordSyntax\n");
658 printf(" elementSetName\n");
659 printf(" maximumRecordSize\n");
660 printf(" preferredRecordSize\n");
662 printf(" piggyback\n");
665 printf(" password\n");
666 printf(" implementationName\n");
667 printf(" charset\n");
669 printf(" timeout\n");
671 printf(" extraArgs\n");
672 printf(" suggestions\n");
676 static int cmd_connect(ZOOM_connection *c, ZOOM_resultset *r,
677 ZOOM_options options,
682 const char *errmsg, *addinfo, *dset;
684 WRBUF host = next_token_new_wrbuf(args);
687 printf("missing host after connect\n");
690 for (j = -1, i = 0; i<MAX_CON; i++)
693 if (c[i] && (h = ZOOM_connection_option_get(c[i], "host")) &&
694 !strcmp(h, wrbuf_cstr(host)))
696 ZOOM_connection_destroy(c[i]);
699 else if (c[i] == 0 && j == -1)
702 if (i == MAX_CON) /* no match .. */
706 printf("no more connection available\n");
710 i = j; /* OK, use this one is available */
712 c[i] = ZOOM_connection_create(options);
713 ZOOM_connection_connect(c[i], wrbuf_cstr(host), 0);
715 if ((error = ZOOM_connection_error_x(c[i], &errmsg, &addinfo, &dset)))
717 printf("%s error: %s (%s:%d) %s\n",
718 ZOOM_connection_option_get(c[i], "host"), errmsg,
719 dset, error, addinfo);
726 /** \brief parse and execute zoomsh command
729 \param options ZOOM options
730 \param buf command string and arguments
732 \retval 1 failure to execute
733 \retval -1 EOF (no more commands or quit seen)
735 static int cmd_parse(ZOOM_connection *c, ZOOM_resultset *r,
736 ZOOM_options options,
743 cmd_len = next_token(buf, &cmd_str);
746 if (is_command("quit", cmd_str, cmd_len))
748 else if (is_command("set", cmd_str, cmd_len))
749 ret = cmd_set(c, r, options, buf);
750 else if (is_command("get", cmd_str, cmd_len))
751 ret = cmd_get(c, r, options, buf);
752 else if (is_command("rget", cmd_str, cmd_len))
753 ret = cmd_rget(c, r, options, buf);
754 else if (is_command("connect", cmd_str, cmd_len))
755 ret = cmd_connect(c, r, options, buf);
756 else if (is_command("open", cmd_str, cmd_len))
757 ret = cmd_connect(c, r, options, buf);
758 else if (is_command("search", cmd_str, cmd_len))
759 ret = cmd_search(c, r, options, buf);
760 else if (is_command("facets", cmd_str, cmd_len))
761 ret = cmd_facets(c, r, options, buf);
762 else if (is_command("find", cmd_str, cmd_len))
763 ret = cmd_search(c, r, options, buf);
764 else if (is_command("show", cmd_str, cmd_len))
765 ret = cmd_show(c, r, options, buf);
766 else if (is_command("suggestions", cmd_str, cmd_len))
767 ret = cmd_suggestions(c, r, options, buf);
768 else if (is_command("close", cmd_str, cmd_len))
769 ret = cmd_close(c, r, options, buf);
770 else if (is_command("help", cmd_str, cmd_len))
771 ret = cmd_help(c, r, options, buf);
772 else if (is_command("ext", cmd_str, cmd_len))
773 ret = cmd_ext(c, r, options, buf);
774 else if (is_command("debug", cmd_str, cmd_len))
775 ret = cmd_debug(c, r, options, buf);
776 else if (is_command("scan", cmd_str, cmd_len))
777 ret = cmd_scan(c, r, options, buf);
778 else if (is_command("sort", cmd_str, cmd_len))
779 ret = cmd_sort(c, r, options, buf);
782 printf("unknown command %.*s\n", cmd_len, cmd_str);
788 static int shell(ZOOM_connection *c, ZOOM_resultset *r,
789 ZOOM_options options, int exit_on_error)
796 const char *bp = buf;
797 #if HAVE_READLINE_READLINE_H
799 line_in = readline("ZOOM>");
805 #if HAVE_READLINE_HISTORY_H
807 add_history(line_in);
809 if (strlen(line_in) > sizeof(buf)-1)
811 printf("Input line too long\n");
818 printf("ZOOM>"); fflush(stdout);
819 if (!fgets(buf, sizeof(buf)-1, stdin))
825 if ((cp = strchr(buf, '\n')))
827 res = cmd_parse(c, r, options, &bp);
830 if (!exit_on_error && res > 0)
836 static int zoomsh(int argc, char **argv)
838 ZOOM_options zoom_options = ZOOM_options_create();
839 int i, res = 0; /* -1: EOF; 0 = OK, > 0 ERROR */
840 int exit_on_error = 0;
841 ZOOM_connection z39_con[MAX_CON];
842 ZOOM_resultset z39_res[MAX_CON];
844 for (i = 0; i<MAX_CON; i++)
853 int option_ret = options("ev:", argv, argc, &arg);
854 const char *bp = arg;
858 res = cmd_parse(z39_con, z39_res, zoom_options, &bp);
859 /* returns res == -1 on quit */
860 if (!exit_on_error && res > 0)
861 res = 0; /* hide error */
863 case YAZ_OPTIONS_EOF:
864 res = shell(z39_con, z39_res, zoom_options, exit_on_error);
870 mask = yaz_log_mask_str(arg);
871 yaz_log_init_level(mask);
874 fprintf(stderr, "zoomsh: [-e] [-v] [commands]\n");
879 for (i = 0; i<MAX_CON; i++)
881 ZOOM_connection_destroy(z39_con[i]);
882 ZOOM_resultset_destroy(z39_res[i]);
884 ZOOM_options_destroy(zoom_options);
885 if (res == -1) /* quit .. which is not an error */
890 int main(int argc, char **argv)
892 int ret = zoomsh(argc, argv);
898 * c-file-style: "Stroustrup"
899 * indent-tabs-mode: nil
901 * vim: shiftwidth=4 tabstop=8 expandtab