a6da27d7c66d5e8601cc7c91ae7c8781ca9cab14
[yaz-moved-to-github.git] / zoom / zoomsh.c
1 /* This file is part of the YAZ toolkit.
2  * Copyright (C) 1995-2009 Index Data
3  * See the file LICENSE for details.
4  */
5
6 /** \file zoomsh.c
7     \brief ZOOM C command line tool (shell)
8 */
9
10 #include <stdio.h>
11 #include <stdlib.h>
12 #include <string.h>
13 #include <ctype.h>
14
15 #include <yaz/comstack.h>
16
17 #if HAVE_READLINE_READLINE_H
18 #include <readline/readline.h> 
19 #endif
20 #if HAVE_READLINE_HISTORY_H
21 #include <readline/history.h>
22 #endif
23
24 #include <yaz/xmalloc.h>
25
26 #include <yaz/log.h>
27 #include <yaz/nmem.h>
28 #include <yaz/zoom.h>
29
30 #define MAX_CON 100
31
32 static int next_token(const char **cpp, const char **t_start)
33 {
34     int len = 0;
35     const char *cp = *cpp;
36     while (*cp == ' ')
37         cp++;
38     if (*cp == '"')
39     {
40         cp++;
41         *t_start = cp;
42         while (*cp && *cp != '"')
43         {
44             cp++;
45             len++;
46         }
47         if (*cp)
48             cp++;
49     }
50     else
51     {
52         *t_start = cp;
53         while (*cp && *cp != ' ' && *cp != '\r' && *cp != '\n')
54         {
55             cp++;
56             len++;
57         }
58         if (len == 0)
59             len = -1;
60     }
61     *cpp = cp;
62     return len;  /* return -1 if no token was read .. */
63 }
64
65 static int next_token_copy(const char **cpp, char *buf_out, int buf_max)
66 {
67     const char *start;
68     int len = next_token(cpp, &start);
69     if (len < 0)
70     {
71         *buf_out = 0;
72         return len;
73     }
74     if (len >= buf_max)
75         len = buf_max-1;
76     memcpy(buf_out, start, len);
77     buf_out[len] = '\0';
78     return len;
79 }
80
81 static int is_command(const char *cmd_str, const char *this_str, int this_len)
82 {
83     int cmd_len = strlen(cmd_str);
84     if (cmd_len != this_len)
85         return 0;
86     if (memcmp(cmd_str, this_str, cmd_len))
87         return 0;
88     return 1;
89 }
90
91 static void cmd_set(ZOOM_connection *c, ZOOM_resultset *r,
92                     ZOOM_options options,
93                     const char **args)
94 {
95     char key[40], val[80];
96
97     if (next_token_copy(args, key, sizeof(key)) < 0)
98     {
99         printf("missing argument for set\n");
100         return ;
101     }
102     if (next_token_copy(args, val, sizeof(val)) < 0)
103         ZOOM_options_set(options, key, 0);
104     else
105         ZOOM_options_set(options, key, val);
106 }
107
108 static void cmd_get(ZOOM_connection *c, ZOOM_resultset *r,
109                     ZOOM_options options,
110                     const char **args)
111 {
112     char key[40];
113     if (next_token_copy(args, key, sizeof(key)) < 0)
114     {
115         printf("missing argument for get\n");
116     }
117     else
118     {
119         const char *val = ZOOM_options_get(options, key);
120         printf("%s = %s\n", key, val ? val : "<null>");
121     }
122 }
123
124 static void cmd_rget(ZOOM_connection *c, ZOOM_resultset *r,
125                      ZOOM_options options,
126                      const char **args)
127 {
128     char key[40];
129     if (next_token_copy(args, key, sizeof(key)) < 0)
130     {
131         printf("missing argument for get\n");
132     }
133     else
134     {
135         int i;
136         for (i = 0; i<MAX_CON; i++)
137         {
138             const char *val;
139             if (!r[i])
140                 continue;
141             
142             val = ZOOM_resultset_option_get(r[i], key);
143             printf("%s = %s\n", key, val ? val : "<null>");
144         }
145     }
146 }
147
148 static void cmd_close(ZOOM_connection *c, ZOOM_resultset *r,
149                       ZOOM_options options,
150                       const char **args)
151 {
152     char host[60];
153     int i;
154     next_token_copy(args, host, sizeof(host));
155     for (i = 0; i<MAX_CON; i++)
156     {
157         const char *h;
158         if (!c[i])
159             continue;
160         if ((h = ZOOM_connection_option_get(c[i], "host"))
161             && !strcmp(h, host))
162         {
163             ZOOM_connection_destroy(c[i]);
164             c[i] = 0;
165         }
166         else if (*host == '\0')
167         {
168             ZOOM_connection_destroy(c[i]);
169             c[i] = 0;
170         }
171     }
172 }
173
174 static void display_records(ZOOM_connection c,
175                             ZOOM_resultset r,
176                             int start, int count, const char *type)
177 {
178     int i;
179     for (i = 0; i<count; i++)
180     {
181         int pos = i + start;
182         ZOOM_record rec = ZOOM_resultset_record(r, pos);
183         const char *db = ZOOM_record_get(rec, "database", 0);
184         
185         if (ZOOM_record_error(rec, 0, 0, 0))
186         {
187             const char *msg;
188             const char *addinfo;
189             const char *diagset;
190             int error = ZOOM_record_error(rec, &msg, &addinfo, &diagset);
191             
192             printf("%d %s: %s (%s:%d) %s\n", pos, (db ? db : "unknown"),
193                    msg, diagset, error, addinfo ? addinfo : "none");
194         }
195         else
196         {
197             int len, opac_len;
198             const char *render = ZOOM_record_get(rec, type, &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 */
203             if (rec)
204             {
205                 printf("%d database=%s syntax=%s schema=%s\n",
206                        pos, (db ? db : "unknown"), syntax,
207                        schema ? schema : "unknown");
208                 if (render)
209                 {
210                     if (fwrite(render, 1, len, stdout) != (size_t) len)
211                     {
212                         printf("write to stdout failed\n");
213                     }
214                 }
215                 printf("\n");
216                 if (opac_render)
217                 {
218                     if (fwrite(opac_render, 1, opac_len, stdout) != (size_t) 
219                                opac_len)
220                         printf("write to stdout failed\n");
221                 }
222             }
223         }
224     }
225 }
226
227 static void cmd_show(ZOOM_connection *c, ZOOM_resultset *r,
228                      ZOOM_options options,
229                      const char **args)
230 {
231     int i;
232     char start_str[10], count_str[10], render_str[60];
233     const char *type = "render";
234
235     if (next_token_copy(args, start_str, sizeof(start_str)) >= 0)
236         ZOOM_options_set(options, "start", start_str);
237
238     if (next_token_copy(args, count_str, sizeof(count_str)) >= 0)
239         ZOOM_options_set(options, "count", count_str);
240
241     if (next_token_copy(args, render_str, sizeof(render_str)) >= 0)
242         type = render_str;
243
244     for (i = 0; i<MAX_CON; i++)
245         ZOOM_resultset_records(r[i], 0, atoi(start_str), atoi(count_str));
246     while (ZOOM_event(MAX_CON, c))
247         ;
248
249     for (i = 0; i<MAX_CON; i++)
250     {
251         int error;
252         const char *errmsg, *addinfo, *dset;
253         /* display errors if any */
254         if (!c[i])
255             continue;
256         if ((error = ZOOM_connection_error_x(c[i], &errmsg, &addinfo, &dset)))
257             printf("%s error: %s (%s:%d) %s\n",
258                    ZOOM_connection_option_get(c[i], "host"), errmsg,
259                    dset, error, addinfo);
260         else if (r[i])
261         {
262             /* OK, no major errors. Display records... */
263             int start = ZOOM_options_get_int(options, "start", 0);
264             int count = ZOOM_options_get_int(options, "count", 0);
265             display_records(c[i], r[i], start, count, type);
266         }
267     }
268     ZOOM_options_set(options, "count", "0");
269     ZOOM_options_set(options, "start", "0");
270 }
271
272 static void cmd_ext(ZOOM_connection *c, ZOOM_resultset *r,
273                     ZOOM_options options,
274                     const char **args)
275 {
276     ZOOM_package p[MAX_CON];
277     char ext_type_str[10];
278     
279     int i;
280
281     if (next_token_copy(args, ext_type_str, sizeof(ext_type_str)) < 0)
282         return;
283     
284     for (i = 0; i<MAX_CON; i++)
285     {
286         if (c[i])
287         {
288             p[i] = ZOOM_connection_package(c[i], 0);
289             ZOOM_package_send(p[i], ext_type_str);
290         }
291         else
292             p[i] = 0;
293     }
294
295     while (ZOOM_event(MAX_CON, c))
296         ;
297
298     for (i = 0; i<MAX_CON; i++)
299     {
300         int error;
301         const char *errmsg, *addinfo, *dset;
302         /* display errors if any */
303         if (!p[i])
304             continue;
305         if ((error = ZOOM_connection_error_x(c[i], &errmsg, &addinfo, &dset)))
306             printf("%s error: %s (%s:%d) %s\n",
307                    ZOOM_connection_option_get(c[i], "host"), errmsg,
308                    dset, error, addinfo);
309         else if (p[i])
310         {
311             const char *v;
312             printf("ok\n");
313             v = ZOOM_package_option_get(p[i], "targetReference");
314             if (v)
315                 printf("targetReference: %s\n", v);
316             v = ZOOM_package_option_get(p[i], "xmlUpdateDoc");
317             if (v)
318                 printf("xmlUpdateDoc: %s\n", v);
319         }
320         ZOOM_package_destroy(p[i]);
321     }
322 }
323
324 static void cmd_debug(ZOOM_connection *c, ZOOM_resultset *r,
325                       ZOOM_options options,
326                       const char **args)
327 {
328     yaz_log_init_level(YLOG_ALL);
329 }
330
331 static void cmd_search(ZOOM_connection *c, ZOOM_resultset *r,
332                        ZOOM_options options,
333                        const char **args)
334 {
335     ZOOM_query s;
336     const char *query_str = *args;
337     int i;
338     
339     s = ZOOM_query_create();
340     while (*query_str == ' ')
341         query_str++;
342     if (memcmp(query_str, "cql:", 4) == 0)
343     {
344         ZOOM_query_cql(s, query_str + 4);
345     }
346     else if (ZOOM_query_prefix(s, query_str))
347     {
348         printf("Bad PQF: %s\n", query_str);
349         return;
350     }
351     for (i = 0; i<MAX_CON; i++)
352     {
353
354         if (c[i])
355         {
356             ZOOM_resultset_destroy(r[i]);
357             r[i] = 0;
358         }
359         if (c[i])
360             r[i] = ZOOM_connection_search(c[i], s);
361     }
362     ZOOM_query_destroy(s);
363
364     while (ZOOM_event(MAX_CON, c))
365         ;
366
367     for (i = 0; i<MAX_CON; i++)
368     {
369         int error;
370         const char *errmsg, *addinfo, *dset;
371         /* display errors if any */
372         if (!c[i])
373             continue;
374         if ((error = ZOOM_connection_error_x(c[i], &errmsg, &addinfo, &dset)))
375             printf("%s error: %s (%s:%d) %s\n",
376                    ZOOM_connection_option_get(c[i], "host"), errmsg,
377                    dset, error, addinfo);
378         else if (r[i])
379         {
380             /* OK, no major errors. Look at the result count */
381             int start = ZOOM_options_get_int(options, "start", 0);
382             int count = ZOOM_options_get_int(options, "count", 0);
383
384             printf("%s: %ld hits\n", ZOOM_connection_option_get(c[i], "host"),
385                    (long) ZOOM_resultset_size(r[i]));
386             /* and display */
387             display_records(c[i], r[i], start, count, "render");
388         }
389     }
390 }
391
392 static void cmd_scan(ZOOM_connection *c, ZOOM_resultset *r,
393                      ZOOM_options options,
394                      const char **args)
395 {
396     const char *query_str = *args;
397     ZOOM_query query = ZOOM_query_create();
398     int i;
399     ZOOM_scanset s[MAX_CON];
400     
401     while (*query_str == ' ')
402         query_str++;
403
404     if (memcmp(query_str, "cql:", 4) == 0)
405     {
406         ZOOM_query_cql(query, query_str + 4);
407     }
408     else if (ZOOM_query_prefix(query, query_str))
409     {
410         printf("Bad PQF: %s\n", query_str);
411         return;
412     }
413
414     for (i = 0; i<MAX_CON; i++)
415     {
416         if (c[i])
417             s[i] = ZOOM_connection_scan1(c[i], query);
418         else
419             s[i] = 0;
420     }
421     ZOOM_query_destroy(query);
422
423     while (ZOOM_event(MAX_CON, c))
424         ;
425     for (i = 0; i<MAX_CON; i++)
426     {
427         int error;
428         const char *errmsg, *addinfo, *dset;
429         /* display errors if any */
430         if (!c[i])
431             continue;
432         if ((error = ZOOM_connection_error_x(c[i], &errmsg, &addinfo, &dset)))
433             printf("%s error: %s (%s:%d) %s\n",
434                    ZOOM_connection_option_get(c[i], "host"), errmsg,
435                    dset, error, addinfo);
436
437         if (s[i]) {
438             size_t p, sz = ZOOM_scanset_size(s[i]);
439             for (p = 0; p < sz; p++)
440             {
441                 int occ = 0;
442                 int len = 0;
443                 const char *term = ZOOM_scanset_display_term(s[i], p,
444                                                              &occ, &len);
445                 
446                 printf("%.*s %d\n", len, term, occ);
447             }            
448             ZOOM_scanset_destroy(s[i]);
449         }
450     }
451 }
452
453 static void cmd_sort(ZOOM_connection *c, ZOOM_resultset *r,
454                      ZOOM_options options,
455                      const char **args)
456 {
457     const char *sort_spec = *args;
458     int i;
459     
460     while (*sort_spec == ' ')
461         sort_spec++;
462     
463     for (i = 0; i<MAX_CON; i++)
464     {
465         if (r[i])
466             ZOOM_resultset_sort(r[i], "yaz", sort_spec);
467     }
468     while (ZOOM_event(MAX_CON, c))
469         ;
470 }
471
472 static void cmd_help(ZOOM_connection *c, ZOOM_resultset *r,
473                      ZOOM_options options,
474                      const char **args)
475 {
476     printf("connect <zurl>\n");
477     printf("search <pqf>\n");
478     printf("show [<start> [<count>]\n");
479     printf("scan <term>\n");
480     printf("quit\n");
481     printf("close <zurl>\n");
482     printf("ext <type>\n");
483     printf("set <option> [<value>]\n");
484     printf("get <option>\n");
485     printf("\n");
486     printf("options:\n");
487     printf(" start\n");
488     printf(" count\n");
489     printf(" databaseName\n");
490     printf(" preferredRecordSyntax\n");
491     printf(" proxy\n");
492     printf(" elementSetName\n");
493     printf(" maximumRecordSize\n");
494     printf(" preferredRecordSize\n");
495     printf(" async\n");
496     printf(" piggyback\n");
497     printf(" group\n");
498     printf(" user\n");
499     printf(" password\n");
500     printf(" implementationName\n");
501     printf(" charset\n");
502     printf(" lang\n");
503 }
504
505 static void cmd_connect(ZOOM_connection *c, ZOOM_resultset *r,
506                         ZOOM_options options,
507                         const char **args)
508 {
509     int error;
510     const char *errmsg, *addinfo, *dset;
511     char host[60];
512     int j, i;
513     if (next_token_copy(args, host, sizeof(host)) < 0)
514     {
515         printf("missing host after connect\n");
516         return ;
517     }
518     for (j = -1, i = 0; i<MAX_CON; i++)
519     {
520         const char *h;
521         if (c[i] && (h = ZOOM_connection_option_get(c[i], "host")) &&
522             !strcmp(h, host))
523         {
524             ZOOM_connection_destroy(c[i]);
525             break;
526         }
527         else if (c[i] == 0 && j == -1)
528             j = i;
529     }
530     if (i == MAX_CON)  /* no match .. */
531     {
532         if (j == -1)
533         {
534             printf("no more connection available\n");
535             return;
536         }
537         i = j;   /* OK, use this one is available */
538     }
539     c[i] = ZOOM_connection_create(options);
540     ZOOM_connection_connect(c[i], host, 0);
541         
542     if ((error = ZOOM_connection_error_x(c[i], &errmsg, &addinfo, &dset)))
543         printf("%s error: %s (%s:%d) %s\n",
544                ZOOM_connection_option_get(c[i], "host"), errmsg,
545                dset, error, addinfo);
546 }
547
548 static int cmd_parse(ZOOM_connection *c, ZOOM_resultset *r,
549                      ZOOM_options options, 
550                      const char **buf)
551 {
552     int cmd_len;
553     const char *cmd_str;
554
555     cmd_len = next_token(buf, &cmd_str);
556     if (cmd_len < 0)
557         return 1;
558     if (is_command("quit", cmd_str, cmd_len))
559         return 0;
560     else if (is_command("set", cmd_str, cmd_len))
561         cmd_set(c, r, options, buf);
562     else if (is_command("get", cmd_str, cmd_len))
563         cmd_get(c, r, options, buf);
564     else if (is_command("rget", cmd_str, cmd_len))
565         cmd_rget(c, r, options, buf);
566     else if (is_command("connect", cmd_str, cmd_len))
567         cmd_connect(c, r, options, buf);
568     else if (is_command("open", cmd_str, cmd_len))
569         cmd_connect(c, r, options, buf);
570     else if (is_command("search", cmd_str, cmd_len))
571         cmd_search(c, r, options, buf);
572     else if (is_command("find", cmd_str, cmd_len))
573         cmd_search(c, r, options, buf);
574     else if (is_command("show", cmd_str, cmd_len))
575         cmd_show(c, r, options, buf);
576     else if (is_command("close", cmd_str, cmd_len))
577         cmd_close(c, r, options, buf);
578     else if (is_command("help", cmd_str, cmd_len))
579         cmd_help(c, r, options, buf);
580     else if (is_command("ext", cmd_str, cmd_len))
581         cmd_ext(c, r, options, buf);
582     else if (is_command("debug", cmd_str, cmd_len))
583         cmd_debug(c, r, options, buf);
584     else if (is_command("scan", cmd_str, cmd_len))
585         cmd_scan(c, r, options, buf);
586     else if (is_command("sort", cmd_str, cmd_len))
587         cmd_sort(c, r, options, buf);
588     else
589         printf("unknown command %.*s\n", cmd_len, cmd_str);
590     return 2;
591 }
592
593 void shell(ZOOM_connection *c, ZOOM_resultset *r,
594            ZOOM_options options)
595 {
596     while (1)
597     {
598         char buf[1000];
599         char *cp;
600         const char *bp = buf;
601 #if HAVE_READLINE_READLINE_H
602         char* line_in;
603         line_in=readline("ZOOM>");
604         if (!line_in)
605             break;
606 #if HAVE_READLINE_HISTORY_H
607         if (*line_in)
608             add_history(line_in);
609 #endif
610         if(strlen(line_in) > 999) {
611             printf("Input line too long\n");
612             break;
613         };
614         strcpy(buf,line_in);
615         free(line_in);
616 #else    
617         printf("ZOOM>"); fflush(stdout);
618         if (!fgets(buf, 999, stdin))
619             break;
620 #endif 
621         if ((cp = strchr(buf, '\n')))
622             *cp = '\0';
623         if (!cmd_parse(c, r, options, &bp))
624             break;
625     }
626 }
627
628 static void zoomsh(int argc, char **argv)
629 {
630     ZOOM_options options = ZOOM_options_create();
631     int i, res;
632     ZOOM_connection z39_con[MAX_CON];
633     ZOOM_resultset  z39_res[MAX_CON];
634
635     for (i = 0; i<MAX_CON; i++)
636     {
637         z39_con[i] = 0;
638         z39_res[i] = 0;
639     }
640
641     for (i = 0; i<MAX_CON; i++)
642         z39_con[i] = 0;
643
644     res = 1;
645     for (i = 1; i<argc; i++)
646     {
647         const char *bp = argv[i];
648         res = cmd_parse(z39_con, z39_res, options, &bp);
649         if (res == 0)  /* received quit */
650             break;
651     }
652     if (res)  /* do cmdline shell only if not quitting */
653         shell(z39_con, z39_res, options);
654     ZOOM_options_destroy(options);
655
656     for (i = 0; i<MAX_CON; i++)
657     {
658         ZOOM_connection_destroy(z39_con[i]);
659         ZOOM_resultset_destroy(z39_res[i]);
660     }
661 }
662
663 int main(int argc, char **argv)
664 {
665     const char *maskstr = 0;
666     if (argc > 2 && !strcmp(argv[1], "-v"))
667     {
668         maskstr = argv[2];
669         argv += 2;
670         argc -= 2;
671     }
672     else if (argc > 1 && !strncmp(argv[1], "-v", 2))
673     {
674         maskstr = argv[1]+2;
675         argv++;
676         argc--;
677     }
678     if (maskstr)
679     {
680         int mask = yaz_log_mask_str(maskstr);
681         yaz_log_init_level(mask);
682     }
683     zoomsh(argc, argv);
684     exit(0);
685 }
686 /*
687  * Local variables:
688  * c-basic-offset: 4
689  * c-file-style: "Stroustrup"
690  * indent-tabs-mode: nil
691  * End:
692  * vim: shiftwidth=4 tabstop=8 expandtab
693  */
694