1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2008 Index Data
3 * See the file LICENSE for details.
7 \brief ZOOM C command line tool (shell)
15 #include <yaz/comstack.h>
17 #if HAVE_READLINE_READLINE_H
18 #include <readline/readline.h>
20 #if HAVE_READLINE_HISTORY_H
21 #include <readline/history.h>
24 #include <yaz/xmalloc.h>
32 static int next_token(const char **cpp, const char **t_start)
35 const char *cp = *cpp;
42 while (*cp && *cp != '"')
53 while (*cp && *cp != ' ' && *cp != '\r' && *cp != '\n')
62 return len; /* return -1 if no token was read .. */
65 static int next_token_copy(const char **cpp, char *buf_out, int buf_max)
68 int len = next_token(cpp, &start);
76 memcpy(buf_out, start, len);
81 static int is_command(const char *cmd_str, const char *this_str, int this_len)
83 int cmd_len = strlen(cmd_str);
84 if (cmd_len != this_len)
86 if (memcmp(cmd_str, this_str, cmd_len))
91 static void cmd_set(ZOOM_connection *c, ZOOM_resultset *r,
95 char key[40], val[80];
97 if (next_token_copy(args, key, sizeof(key)) < 0)
99 printf("missing argument for set\n");
102 if (next_token_copy(args, val, sizeof(val)) < 0)
103 ZOOM_options_set(options, key, 0);
105 ZOOM_options_set(options, key, val);
108 static void cmd_get(ZOOM_connection *c, ZOOM_resultset *r,
109 ZOOM_options options,
113 if (next_token_copy(args, key, sizeof(key)) < 0)
115 printf("missing argument for get\n");
119 const char *val = ZOOM_options_get(options, key);
120 printf("%s = %s\n", key, val ? val : "<null>");
124 static void cmd_rget(ZOOM_connection *c, ZOOM_resultset *r,
125 ZOOM_options options,
129 if (next_token_copy(args, key, sizeof(key)) < 0)
131 printf("missing argument for get\n");
136 for (i = 0; i<MAX_CON; i++)
142 val = ZOOM_resultset_option_get(r[i], key);
143 printf("%s = %s\n", key, val ? val : "<null>");
148 static void cmd_close(ZOOM_connection *c, ZOOM_resultset *r,
149 ZOOM_options options,
154 next_token_copy(args, host, sizeof(host));
155 for (i = 0; i<MAX_CON; i++)
160 if ((h = ZOOM_connection_option_get(c[i], "host"))
163 ZOOM_connection_destroy(c[i]);
166 else if (*host == '\0')
168 ZOOM_connection_destroy(c[i]);
174 static void display_records(ZOOM_connection c,
176 int start, int count)
179 for (i = 0; i<count; i++)
182 ZOOM_record rec = ZOOM_resultset_record(r, pos);
183 const char *db = ZOOM_record_get(rec, "database", 0);
185 if (ZOOM_record_error(rec, 0, 0, 0))
190 int error = ZOOM_record_error(rec, &msg, &addinfo, &diagset);
192 printf("%d %s: %s (%s:%d) %s\n", pos, (db ? db : "unknown"),
193 msg, diagset, error, addinfo ? addinfo : "none");
198 const char *render = ZOOM_record_get(rec, "render", &len);
199 const char *opac_render = ZOOM_record_get(rec, "opac", &opac_len);
200 const char *syntax = ZOOM_record_get(rec, "syntax", 0);
201 const char *schema = ZOOM_record_get(rec, "schema", 0);
202 /* if rec is non-null, we got a record for display */
205 printf("%d database=%s syntax=%s schema=%s\n",
206 pos, (db ? db : "unknown"), syntax,
207 schema ? schema : "unknown");
210 if (write(render, 1, len, stdout) != len)
212 printf("write to stdout failed\n");
218 if (fwrite(opac_render, 1, opac_len, stdout) != opac_len)
219 printf("write to stdout failed\n");
226 static void cmd_show(ZOOM_connection *c, ZOOM_resultset *r,
227 ZOOM_options options,
231 char start_str[10], count_str[10];
233 if (next_token_copy(args, start_str, sizeof(start_str)) >= 0)
234 ZOOM_options_set(options, "start", start_str);
236 if (next_token_copy(args, count_str, sizeof(count_str)) >= 0)
237 ZOOM_options_set(options, "count", count_str);
239 for (i = 0; i<MAX_CON; i++)
240 ZOOM_resultset_records(r[i], 0, atoi(start_str), atoi(count_str));
241 while (ZOOM_event(MAX_CON, c))
244 for (i = 0; i<MAX_CON; i++)
247 const char *errmsg, *addinfo, *dset;
248 /* display errors if any */
251 if ((error = ZOOM_connection_error_x(c[i], &errmsg, &addinfo, &dset)))
252 printf("%s error: %s (%s:%d) %s\n",
253 ZOOM_connection_option_get(c[i], "host"), errmsg,
254 dset, error, addinfo);
257 /* OK, no major errors. Display records... */
258 int start = ZOOM_options_get_int(options, "start", 0);
259 int count = ZOOM_options_get_int(options, "count", 0);
260 display_records(c[i], r[i], start, count);
263 ZOOM_options_set(options, "count", "0");
264 ZOOM_options_set(options, "start", "0");
267 static void cmd_ext(ZOOM_connection *c, ZOOM_resultset *r,
268 ZOOM_options options,
271 ZOOM_package p[MAX_CON];
272 char ext_type_str[10];
276 if (next_token_copy(args, ext_type_str, sizeof(ext_type_str)) < 0)
279 for (i = 0; i<MAX_CON; i++)
283 p[i] = ZOOM_connection_package(c[i], 0);
284 ZOOM_package_send(p[i], ext_type_str);
290 while (ZOOM_event(MAX_CON, c))
293 for (i = 0; i<MAX_CON; i++)
296 const char *errmsg, *addinfo, *dset;
297 /* display errors if any */
300 if ((error = ZOOM_connection_error_x(c[i], &errmsg, &addinfo, &dset)))
301 printf("%s error: %s (%s:%d) %s\n",
302 ZOOM_connection_option_get(c[i], "host"), errmsg,
303 dset, error, addinfo);
308 v = ZOOM_package_option_get(p[i], "targetReference");
310 printf("targetReference: %s\n", v);
311 v = ZOOM_package_option_get(p[i], "xmlUpdateDoc");
313 printf("xmlUpdateDoc: %s\n", v);
315 ZOOM_package_destroy(p[i]);
319 static void cmd_debug(ZOOM_connection *c, ZOOM_resultset *r,
320 ZOOM_options options,
323 yaz_log_init_level(YLOG_ALL);
326 static void cmd_search(ZOOM_connection *c, ZOOM_resultset *r,
327 ZOOM_options options,
331 const char *query_str = *args;
334 s = ZOOM_query_create();
335 while (*query_str == ' ')
337 if (memcmp(query_str, "cql:", 4) == 0)
339 ZOOM_query_cql(s, query_str + 4);
341 else if (ZOOM_query_prefix(s, query_str))
343 printf("Bad PQF: %s\n", query_str);
346 for (i = 0; i<MAX_CON; i++)
351 ZOOM_resultset_destroy(r[i]);
355 r[i] = ZOOM_connection_search(c[i], s);
357 ZOOM_query_destroy(s);
359 while (ZOOM_event(MAX_CON, c))
362 for (i = 0; i<MAX_CON; i++)
365 const char *errmsg, *addinfo, *dset;
366 /* display errors if any */
369 if ((error = ZOOM_connection_error_x(c[i], &errmsg, &addinfo, &dset)))
370 printf("%s error: %s (%s:%d) %s\n",
371 ZOOM_connection_option_get(c[i], "host"), errmsg,
372 dset, error, addinfo);
375 /* OK, no major errors. Look at the result count */
376 int start = ZOOM_options_get_int(options, "start", 0);
377 int count = ZOOM_options_get_int(options, "count", 0);
379 printf("%s: %ld hits\n", ZOOM_connection_option_get(c[i], "host"),
380 (long) ZOOM_resultset_size(r[i]));
382 display_records(c[i], r[i], start, count);
387 static void cmd_scan(ZOOM_connection *c, ZOOM_resultset *r,
388 ZOOM_options options,
391 const char *query_str = *args;
392 ZOOM_query query = ZOOM_query_create();
394 ZOOM_scanset s[MAX_CON];
396 while (*query_str == ' ')
399 if (memcmp(query_str, "cql:", 4) == 0)
401 ZOOM_query_cql(query, query_str + 4);
403 else if (ZOOM_query_prefix(query, query_str))
405 printf("Bad PQF: %s\n", query_str);
409 for (i = 0; i<MAX_CON; i++)
412 s[i] = ZOOM_connection_scan1(c[i], query);
416 ZOOM_query_destroy(query);
418 while (ZOOM_event(MAX_CON, c))
420 for (i = 0; i<MAX_CON; i++)
423 const char *errmsg, *addinfo, *dset;
424 /* display errors if any */
427 if ((error = ZOOM_connection_error_x(c[i], &errmsg, &addinfo, &dset)))
428 printf("%s error: %s (%s:%d) %s\n",
429 ZOOM_connection_option_get(c[i], "host"), errmsg,
430 dset, error, addinfo);
433 size_t p, sz = ZOOM_scanset_size(s[i]);
434 for (p = 0; p < sz; p++)
438 const char *term = ZOOM_scanset_display_term(s[i], p,
441 printf("%.*s %d\n", len, term, occ);
443 ZOOM_scanset_destroy(s[i]);
448 static void cmd_sort(ZOOM_connection *c, ZOOM_resultset *r,
449 ZOOM_options options,
452 const char *sort_spec = *args;
455 while (*sort_spec == ' ')
458 for (i = 0; i<MAX_CON; i++)
461 ZOOM_resultset_sort(r[i], "yaz", sort_spec);
463 while (ZOOM_event(MAX_CON, c))
467 static void cmd_help(ZOOM_connection *c, ZOOM_resultset *r,
468 ZOOM_options options,
471 printf("connect <zurl>\n");
472 printf("search <pqf>\n");
473 printf("show [<start> [<count>]\n");
474 printf("scan <term>\n");
476 printf("close <zurl>\n");
477 printf("ext <type>\n");
478 printf("set <option> [<value>]\n");
479 printf("get <option>\n");
481 printf("options:\n");
484 printf(" databaseName\n");
485 printf(" preferredRecordSyntax\n");
487 printf(" elementSetName\n");
488 printf(" maximumRecordSize\n");
489 printf(" preferredRecordSize\n");
491 printf(" piggyback\n");
494 printf(" password\n");
495 printf(" implementationName\n");
496 printf(" charset\n");
500 static void cmd_connect(ZOOM_connection *c, ZOOM_resultset *r,
501 ZOOM_options options,
505 const char *errmsg, *addinfo, *dset;
508 if (next_token_copy(args, host, sizeof(host)) < 0)
510 printf("missing host after connect\n");
513 for (j = -1, i = 0; i<MAX_CON; i++)
516 if (c[i] && (h = ZOOM_connection_option_get(c[i], "host")) &&
519 ZOOM_connection_destroy(c[i]);
522 else if (c[i] == 0 && j == -1)
525 if (i == MAX_CON) /* no match .. */
529 printf("no more connection available\n");
532 i = j; /* OK, use this one is available */
534 c[i] = ZOOM_connection_create(options);
535 ZOOM_connection_connect(c[i], host, 0);
537 if ((error = ZOOM_connection_error_x(c[i], &errmsg, &addinfo, &dset)))
538 printf("%s error: %s (%s:%d) %s\n",
539 ZOOM_connection_option_get(c[i], "host"), errmsg,
540 dset, error, addinfo);
543 static int cmd_parse(ZOOM_connection *c, ZOOM_resultset *r,
544 ZOOM_options options,
550 cmd_len = next_token(buf, &cmd_str);
553 if (is_command("quit", cmd_str, cmd_len))
555 else if (is_command("set", cmd_str, cmd_len))
556 cmd_set(c, r, options, buf);
557 else if (is_command("get", cmd_str, cmd_len))
558 cmd_get(c, r, options, buf);
559 else if (is_command("rget", cmd_str, cmd_len))
560 cmd_rget(c, r, options, buf);
561 else if (is_command("connect", cmd_str, cmd_len))
562 cmd_connect(c, r, options, buf);
563 else if (is_command("open", cmd_str, cmd_len))
564 cmd_connect(c, r, options, buf);
565 else if (is_command("search", cmd_str, cmd_len))
566 cmd_search(c, r, options, buf);
567 else if (is_command("find", cmd_str, cmd_len))
568 cmd_search(c, r, options, buf);
569 else if (is_command("show", cmd_str, cmd_len))
570 cmd_show(c, r, options, buf);
571 else if (is_command("close", cmd_str, cmd_len))
572 cmd_close(c, r, options, buf);
573 else if (is_command("help", cmd_str, cmd_len))
574 cmd_help(c, r, options, buf);
575 else if (is_command("ext", cmd_str, cmd_len))
576 cmd_ext(c, r, options, buf);
577 else if (is_command("debug", cmd_str, cmd_len))
578 cmd_debug(c, r, options, buf);
579 else if (is_command("scan", cmd_str, cmd_len))
580 cmd_scan(c, r, options, buf);
581 else if (is_command("sort", cmd_str, cmd_len))
582 cmd_sort(c, r, options, buf);
584 printf("unknown command %.*s\n", cmd_len, cmd_str);
588 void shell(ZOOM_connection *c, ZOOM_resultset *r,
589 ZOOM_options options)
595 const char *bp = buf;
596 #if HAVE_READLINE_READLINE_H
598 line_in=readline("ZOOM>");
601 #if HAVE_READLINE_HISTORY_H
603 add_history(line_in);
605 if(strlen(line_in) > 999) {
606 printf("Input line too long\n");
612 printf("ZOOM>"); fflush(stdout);
613 if (!fgets(buf, 999, stdin))
616 if ((cp = strchr(buf, '\n')))
618 if (!cmd_parse(c, r, options, &bp))
623 static void zoomsh(int argc, char **argv)
625 ZOOM_options options = ZOOM_options_create();
627 ZOOM_connection z39_con[MAX_CON];
628 ZOOM_resultset z39_res[MAX_CON];
630 for (i = 0; i<MAX_CON; i++)
636 for (i = 0; i<MAX_CON; i++)
640 for (i = 1; i<argc; i++)
642 const char *bp = argv[i];
643 res = cmd_parse(z39_con, z39_res, options, &bp);
644 if (res == 0) /* received quit */
647 if (res) /* do cmdline shell only if not quitting */
648 shell(z39_con, z39_res, options);
649 ZOOM_options_destroy(options);
651 for (i = 0; i<MAX_CON; i++)
653 ZOOM_connection_destroy(z39_con[i]);
654 ZOOM_resultset_destroy(z39_res[i]);
658 int main(int argc, char **argv)
660 const char *maskstr = 0;
661 if (argc > 2 && !strcmp(argv[1], "-v"))
667 else if (argc > 1 && !strncmp(argv[1], "-v", 2))
675 int mask = yaz_log_mask_str(maskstr);
676 yaz_log_init_level(mask);
684 * indent-tabs-mode: nil
686 * vim: shiftwidth=4 tabstop=8 expandtab