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_shell(ZOOM_connection *c, ZOOM_resultset *r,
152 ZOOM_options options, const char **args)
154 int ret = system(*args);
156 printf("system command returned %d\n", ret);
160 static int cmd_rget(ZOOM_connection *c, ZOOM_resultset *r,
161 ZOOM_options options,
165 if (!(key = next_token_new_wrbuf(args)))
167 printf("missing argument for get\n");
173 for (i = 0; i<MAX_CON; i++)
179 val = ZOOM_resultset_option_get(r[i], wrbuf_cstr(key));
180 printf("%s = %s\n", wrbuf_cstr(key), val ? val : "<null>");
187 static int cmd_close(ZOOM_connection *c, ZOOM_resultset *r,
188 ZOOM_options options,
193 host = next_token_new_wrbuf(args);
194 for (i = 0; i<MAX_CON; i++)
201 ZOOM_connection_destroy(c[i]);
204 else if ((h = ZOOM_connection_option_get(c[i], "host"))
205 && !strcmp(h, wrbuf_cstr(host)))
207 ZOOM_connection_destroy(c[i]);
216 static void display_records(ZOOM_connection c,
218 size_t start, size_t count, const char *type)
221 for (i = 0; i < count; i++)
223 size_t pos = i + start;
224 ZOOM_record rec = ZOOM_resultset_record(r, pos);
225 const char *db = ZOOM_record_get(rec, "database", 0);
227 if (ZOOM_record_error(rec, 0, 0, 0))
232 int error = ZOOM_record_error(rec, &msg, &addinfo, &diagset);
234 printf("%lld %s: %s (%s:%d) %s\n", (long long) pos,
235 (db ? db : "unknown"),
236 msg, diagset, error, addinfo ? addinfo : "none");
241 const char *render = ZOOM_record_get(rec, type, &len);
242 const char *syntax = ZOOM_record_get(rec, "syntax", 0);
243 const char *schema = ZOOM_record_get(rec, "schema", 0);
244 /* if rec is non-null, we got a record for display */
247 printf("%lld database=%s syntax=%s schema=%s\n",
248 (long long) pos, (db ? db : "unknown"), syntax,
249 schema ? schema : "unknown");
252 if (fwrite(render, 1, len, stdout) != (size_t) len)
254 printf("write to stdout failed\n");
263 static int cmd_show(ZOOM_connection *c, ZOOM_resultset *r,
264 ZOOM_options options,
268 size_t start = 0, count = 1;
269 const char *type = "render";
270 WRBUF render_str = 0;
276 if ((tmp = next_token_new_wrbuf(args)))
278 start = atoi(wrbuf_cstr(tmp));
282 if ((tmp = next_token_new_wrbuf(args)))
284 count = atoi(wrbuf_cstr(tmp));
287 render_str = next_token_new_wrbuf(args);
290 type = wrbuf_cstr(render_str);
292 for (i = 0; i < MAX_CON; i++)
293 ZOOM_resultset_records(r[i], 0, start, count);
296 for (i = 0; i < MAX_CON; i++)
299 const char *errmsg, *addinfo, *dset;
300 /* display errors if any */
303 if ((error = ZOOM_connection_error_x(c[i], &errmsg, &addinfo, &dset)))
305 printf("%s error: %s (%s:%d) %s\n",
306 ZOOM_connection_option_get(c[i], "host"), errmsg,
307 dset, error, addinfo);
312 /* OK, no major errors. Display records... */
313 display_records(c[i], r[i], start, count, type);
317 wrbuf_destroy(render_str);
321 static void display_facets(ZOOM_facet_field *facets, int count) {
323 printf("Facets: \n");
324 for (index = 0; index < count; index++) {
326 const char *facet_name = ZOOM_facet_field_name(facets[index]);
327 printf(" %s: \n", facet_name);
328 for (term_index = 0; term_index < ZOOM_facet_field_term_count(facets[index]); term_index++) {
330 const char *term = ZOOM_facet_field_get_term(facets[index], term_index, &freq);
331 printf(" %s(%d) \n", term, freq);
336 static int cmd_facets(ZOOM_connection *c, ZOOM_resultset *r,
337 ZOOM_options options,
345 for (i = 0; i < MAX_CON; i++)
348 const char *errmsg, *addinfo, *dset;
349 /* display errors if any */
352 if ((error = ZOOM_connection_error_x(c[i], &errmsg, &addinfo, &dset)))
354 printf("%s error: %s (%s:%d) %s\n",
355 ZOOM_connection_option_get(c[i], "host"), errmsg,
356 dset, error, addinfo);
361 int num_facets = ZOOM_resultset_facets_size(r[i]);
363 ZOOM_facet_field *facets = ZOOM_resultset_facets(r[i]);
364 display_facets(facets, num_facets);
371 static int cmd_suggestions(ZOOM_connection *c, ZOOM_resultset *r, ZOOM_options options, const char **args)
378 for (i = 0; i < MAX_CON; i++)
381 const char *errmsg, *addinfo, *dset;
382 /* display errors if any */
385 if ((error = ZOOM_connection_error_x(c[i], &errmsg, &addinfo, &dset)))
387 printf("%s error: %s (%s:%d) %s\n",
388 ZOOM_connection_option_get(c[i], "host"), errmsg,
389 dset, error, addinfo);
394 const char *suggestions = ZOOM_resultset_option_get(r[i], "suggestions");
396 printf("Suggestions: \n%s\n", suggestions);
404 static int cmd_ext(ZOOM_connection *c, ZOOM_resultset *r,
405 ZOOM_options options,
408 ZOOM_package p[MAX_CON];
411 WRBUF ext_type_str = next_token_new_wrbuf(args);
415 printf("es: missing type "
416 "(itemorder, create, drop, commit, update, xmlupdate)\n");
419 for (i = 0; i<MAX_CON; i++)
423 p[i] = ZOOM_connection_package(c[i], 0);
424 ZOOM_package_send(p[i], ext_type_str ? wrbuf_cstr(ext_type_str):0);
432 for (i = 0; i<MAX_CON; i++)
435 const char *errmsg, *addinfo, *dset;
436 /* display errors if any */
439 if ((error = ZOOM_connection_error_x(c[i], &errmsg, &addinfo, &dset)))
441 printf("%s error: %s (%s:%d) %s\n",
442 ZOOM_connection_option_get(c[i], "host"), errmsg,
443 dset, error, addinfo);
450 v = ZOOM_package_option_get(p[i], "targetReference");
452 printf("targetReference: %s\n", v);
453 v = ZOOM_package_option_get(p[i], "xmlUpdateDoc");
455 printf("xmlUpdateDoc: %s\n", v);
457 ZOOM_package_destroy(p[i]);
460 wrbuf_destroy(ext_type_str);
464 static int cmd_debug(ZOOM_connection *c, ZOOM_resultset *r,
465 ZOOM_options options,
468 yaz_log_init_level(YLOG_ALL);
472 static int cmd_search(ZOOM_connection *c, ZOOM_resultset *r,
473 ZOOM_options options,
477 const char *query_str = *args;
481 s = ZOOM_query_create();
482 while (*query_str == ' ')
484 if (memcmp(query_str, "cql:", 4) == 0)
486 ZOOM_query_cql(s, query_str + 4);
488 else if (ZOOM_query_prefix(s, query_str))
490 printf("Bad PQF: %s\n", query_str);
491 ZOOM_query_destroy(s);
494 for (i = 0; i<MAX_CON; i++)
499 ZOOM_resultset_destroy(r[i]);
503 r[i] = ZOOM_connection_search(c[i], s);
505 ZOOM_query_destroy(s);
509 for (i = 0; i<MAX_CON; i++)
512 const char *errmsg, *addinfo, *dset;
513 /* display errors if any */
516 if ((error = ZOOM_connection_error_x(c[i], &errmsg, &addinfo, &dset)))
518 printf("%s error: %s (%s:%d) %s\n",
519 ZOOM_connection_option_get(c[i], "host"), errmsg,
520 dset, error, addinfo);
525 /* OK, no major errors. Look at the result count */
526 int start = ZOOM_options_get_int(options, "start", 0);
527 int count = ZOOM_options_get_int(options, "count", 0);
530 printf("%s: %lld hits\n", ZOOM_connection_option_get(c[i], "host"),
531 (long long int) ZOOM_resultset_size(r[i]));
533 facet_num = ZOOM_resultset_facets_size(r[i]);
536 ZOOM_facet_field *facets = ZOOM_resultset_facets(r[i]);
538 for (facet_idx = 0; facet_idx < facet_num; facet_idx++)
540 const char *name = ZOOM_facet_field_name(facets[facet_idx]);
542 size_t term_num = ZOOM_facet_field_term_count(facets[facet_idx]);
543 printf("facet: %s\n", name);
544 for (term_idx = 0; term_idx < term_num; term_idx++ )
548 ZOOM_facet_field_get_term(facets[facet_idx], term_idx, &freq);
549 printf("term: %s %d\n", term, freq);
554 display_records(c[i], r[i], start, count, "render");
560 static int cmd_scan(ZOOM_connection *c, ZOOM_resultset *r,
561 ZOOM_options options,
564 const char *query_str = *args;
565 ZOOM_query query = ZOOM_query_create();
568 ZOOM_scanset s[MAX_CON];
570 while (*query_str == ' ')
573 if (memcmp(query_str, "cql:", 4) == 0)
575 ZOOM_query_cql(query, query_str + 4);
577 else if (ZOOM_query_prefix(query, query_str))
579 printf("Bad PQF: %s\n", query_str);
580 ZOOM_query_destroy(query);
584 for (i = 0; i<MAX_CON; i++)
587 s[i] = ZOOM_connection_scan1(c[i], query);
591 ZOOM_query_destroy(query);
595 for (i = 0; i<MAX_CON; i++)
598 const char *errmsg, *addinfo, *dset;
599 /* display errors if any */
602 if ((error = ZOOM_connection_error_x(c[i], &errmsg, &addinfo, &dset)))
604 printf("%s error: %s (%s:%d) %s\n",
605 ZOOM_connection_option_get(c[i], "host"), errmsg,
606 dset, error, addinfo);
611 size_t p, sz = ZOOM_scanset_size(s[i]);
612 for (p = 0; p < sz; p++)
616 const char *term = ZOOM_scanset_display_term(s[i], p,
618 printf("%.*s %lld\n", (int) len, term, (long long int) occ);
620 ZOOM_scanset_destroy(s[i]);
626 static int cmd_sort(ZOOM_connection *c, ZOOM_resultset *r,
627 ZOOM_options options,
630 const char *sort_spec = *args;
634 while (*sort_spec == ' ')
637 for (i = 0; i<MAX_CON; i++)
640 ZOOM_resultset_sort(r[i], "yaz", sort_spec);
646 static int cmd_help(ZOOM_connection *c, ZOOM_resultset *r,
647 ZOOM_options options,
650 printf("connect <zurl>\n");
651 printf("search <pqf>\n");
652 printf("show [<start> [<count> [<type]]]\n");
654 printf("scan <term>\n");
656 printf("close <zurl>\n");
657 printf("ext <type>\n");
658 printf("set <option> [<value>]\n");
659 printf("get <option>\n");
660 printf("shell cmdline\n");
662 printf("options:\n");
665 printf(" databaseName\n");
666 printf(" preferredRecordSyntax\n");
668 printf(" elementSetName\n");
669 printf(" maximumRecordSize\n");
670 printf(" preferredRecordSize\n");
672 printf(" piggyback\n");
675 printf(" password\n");
676 printf(" implementationName\n");
677 printf(" charset\n");
679 printf(" timeout\n");
681 printf(" extraArgs\n");
682 printf(" suggestions\n");
686 static int cmd_connect(ZOOM_connection *c, ZOOM_resultset *r,
687 ZOOM_options options,
692 const char *errmsg, *addinfo, *dset;
694 WRBUF host = next_token_new_wrbuf(args);
697 printf("missing host after connect\n");
700 for (j = -1, i = 0; i<MAX_CON; i++)
703 if (c[i] && (h = ZOOM_connection_option_get(c[i], "host")) &&
704 !strcmp(h, wrbuf_cstr(host)))
706 ZOOM_connection_destroy(c[i]);
709 else if (c[i] == 0 && j == -1)
712 if (i == MAX_CON) /* no match .. */
716 printf("no more connection available\n");
720 i = j; /* OK, use this one is available */
722 c[i] = ZOOM_connection_create(options);
723 ZOOM_connection_connect(c[i], wrbuf_cstr(host), 0);
725 if ((error = ZOOM_connection_error_x(c[i], &errmsg, &addinfo, &dset)))
727 printf("%s error: %s (%s:%d) %s\n",
728 ZOOM_connection_option_get(c[i], "host"), errmsg,
729 dset, error, addinfo);
736 /** \brief parse and execute zoomsh command
739 \param options ZOOM options
740 \param buf command string and arguments
742 \retval 1 failure to execute
743 \retval -1 EOF (no more commands or quit seen)
745 static int cmd_parse(ZOOM_connection *c, ZOOM_resultset *r,
746 ZOOM_options options,
753 cmd_len = next_token(buf, &cmd_str);
756 if (is_command("quit", cmd_str, cmd_len))
758 else if (is_command("set", cmd_str, cmd_len))
759 ret = cmd_set(c, r, options, buf);
760 else if (is_command("get", cmd_str, cmd_len))
761 ret = cmd_get(c, r, options, buf);
762 else if (is_command("rget", cmd_str, cmd_len))
763 ret = cmd_rget(c, r, options, buf);
764 else if (is_command("connect", cmd_str, cmd_len))
765 ret = cmd_connect(c, r, options, buf);
766 else if (is_command("open", cmd_str, cmd_len))
767 ret = cmd_connect(c, r, options, buf);
768 else if (is_command("search", cmd_str, cmd_len))
769 ret = cmd_search(c, r, options, buf);
770 else if (is_command("facets", cmd_str, cmd_len))
771 ret = cmd_facets(c, r, options, buf);
772 else if (is_command("find", cmd_str, cmd_len))
773 ret = cmd_search(c, r, options, buf);
774 else if (is_command("show", cmd_str, cmd_len))
775 ret = cmd_show(c, r, options, buf);
776 else if (is_command("suggestions", cmd_str, cmd_len))
777 ret = cmd_suggestions(c, r, options, buf);
778 else if (is_command("close", cmd_str, cmd_len))
779 ret = cmd_close(c, r, options, buf);
780 else if (is_command("help", cmd_str, cmd_len))
781 ret = cmd_help(c, r, options, buf);
782 else if (is_command("ext", cmd_str, cmd_len))
783 ret = cmd_ext(c, r, options, buf);
784 else if (is_command("debug", cmd_str, cmd_len))
785 ret = cmd_debug(c, r, options, buf);
786 else if (is_command("scan", cmd_str, cmd_len))
787 ret = cmd_scan(c, r, options, buf);
788 else if (is_command("sort", cmd_str, cmd_len))
789 ret = cmd_sort(c, r, options, buf);
790 else if (is_command("shell", cmd_str, cmd_len))
791 ret = cmd_shell(c, r, options, buf);
794 printf("unknown command %.*s\n", cmd_len, cmd_str);
800 static int shell(ZOOM_connection *c, ZOOM_resultset *r,
801 ZOOM_options options, int exit_on_error)
808 const char *bp = buf;
809 #if HAVE_READLINE_READLINE_H
811 line_in = readline("ZOOM>");
817 #if HAVE_READLINE_HISTORY_H
819 add_history(line_in);
821 if (strlen(line_in) > sizeof(buf)-1)
823 printf("Input line too long\n");
830 printf("ZOOM>"); fflush(stdout);
831 if (!fgets(buf, sizeof(buf)-1, stdin))
837 if ((cp = strchr(buf, '\n')))
839 res = cmd_parse(c, r, options, &bp);
842 if (!exit_on_error && res > 0)
848 static int zoomsh(int argc, char **argv)
850 ZOOM_options zoom_options = ZOOM_options_create();
851 int i, res = 0; /* -1: EOF; 0 = OK, > 0 ERROR */
852 int exit_on_error = 0;
853 ZOOM_connection z39_con[MAX_CON];
854 ZOOM_resultset z39_res[MAX_CON];
856 for (i = 0; i<MAX_CON; i++)
865 int option_ret = options("ev:", argv, argc, &arg);
866 const char *bp = arg;
870 res = cmd_parse(z39_con, z39_res, zoom_options, &bp);
871 /* returns res == -1 on quit */
872 if (!exit_on_error && res > 0)
873 res = 0; /* hide error */
875 case YAZ_OPTIONS_EOF:
876 res = shell(z39_con, z39_res, zoom_options, exit_on_error);
882 mask = yaz_log_mask_str(arg);
883 yaz_log_init_level(mask);
886 fprintf(stderr, "zoomsh: [-e] [-v] [commands]\n");
891 for (i = 0; i<MAX_CON; i++)
893 ZOOM_connection_destroy(z39_con[i]);
894 ZOOM_resultset_destroy(z39_res[i]);
896 ZOOM_options_destroy(zoom_options);
897 if (res == -1) /* quit .. which is not an error */
902 int main(int argc, char **argv)
904 int ret = zoomsh(argc, argv);
910 * c-file-style: "Stroustrup"
911 * indent-tabs-mode: nil
913 * vim: shiftwidth=4 tabstop=8 expandtab