zoom/zoomsh.c

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 1995-2008 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)
 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, "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 */
 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                     fwrite(render, 1, len, stdout);
 210                 printf("\n");
 211                 if (opac_render)
 212                     fwrite(opac_render, 1, opac_len, stdout);
 213             }
 214         }
 215     }
 216 }
 217
 218 static void cmd_show(ZOOM_connection *c, ZOOM_resultset *r,
 219                      ZOOM_options options,
 220                      const char **args)
 221 {
 222     int i;
 223     char start_str[10], count_str[10];
 224
 225     if (next_token_copy(args, start_str, sizeof(start_str)) >= 0)
 226         ZOOM_options_set(options, "start", start_str);
 227
 228     if (next_token_copy(args, count_str, sizeof(count_str)) >= 0)
 229         ZOOM_options_set(options, "count", count_str);
 230
 231     for (i = 0; i<MAX_CON; i++)
 232         ZOOM_resultset_records(r[i], 0, atoi(start_str), atoi(count_str));
 233     while (ZOOM_event(MAX_CON, c))
 234         ;
 235
 236     for (i = 0; i<MAX_CON; i++)
 237     {
 238         int error;
 239         const char *errmsg, *addinfo, *dset;
 240         /* display errors if any */
 241         if (!c[i])
 242             continue;
 243         if ((error = ZOOM_connection_error_x(c[i], &errmsg, &addinfo, &dset)))
 244             printf("%s error: %s (%s:%d) %s\n",
 245                    ZOOM_connection_option_get(c[i], "host"), errmsg,
 246                    dset, error, addinfo);
 247         else if (r[i])
 248         {
 249             /* OK, no major errors. Display records... */
 250             int start = ZOOM_options_get_int(options, "start", 0);
 251             int count = ZOOM_options_get_int(options, "count", 0);
 252             display_records(c[i], r[i], start, count);
 253         }
 254     }
 255     ZOOM_options_set(options, "count", "0");
 256     ZOOM_options_set(options, "start", "0");
 257 }
 258
 259 static void cmd_ext(ZOOM_connection *c, ZOOM_resultset *r,
 260                     ZOOM_options options,
 261                     const char **args)
 262 {
 263     ZOOM_package p[MAX_CON];
 264     char ext_type_str[10];
 265
 266     int i;
 267
 268     if (next_token_copy(args, ext_type_str, sizeof(ext_type_str)) < 0)
 269         return;
 270
 271     for (i = 0; i<MAX_CON; i++)
 272     {
 273         if (c[i])
 274         {
 275             p[i] = ZOOM_connection_package(c[i], 0);
 276             ZOOM_package_send(p[i], ext_type_str);
 277         }
 278         else
 279             p[i] = 0;
 280     }
 281
 282     while (ZOOM_event(MAX_CON, c))
 283         ;
 284
 285     for (i = 0; i<MAX_CON; i++)
 286     {
 287         int error;
 288         const char *errmsg, *addinfo, *dset;
 289         /* display errors if any */
 290         if (!p[i])
 291             continue;
 292         if ((error = ZOOM_connection_error_x(c[i], &errmsg, &addinfo, &dset)))
 293             printf("%s error: %s (%s:%d) %s\n",
 294                    ZOOM_connection_option_get(c[i], "host"), errmsg,
 295                    dset, error, addinfo);
 296         else if (p[i])
 297         {
 298             const char *v;
 299             printf("ok\n");
 300             v = ZOOM_package_option_get(p[i], "targetReference");
 301             if (v)
 302                 printf("targetReference: %s\n", v);
 303             v = ZOOM_package_option_get(p[i], "xmlUpdateDoc");
 304             if (v)
 305                 printf("xmlUpdateDoc: %s\n", v);
 306         }
 307         ZOOM_package_destroy(p[i]);
 308     }
 309 }
 310
 311 static void cmd_debug(ZOOM_connection *c, ZOOM_resultset *r,
 312                       ZOOM_options options,
 313                       const char **args)
 314 {
 315     yaz_log_init_level(YLOG_ALL);
 316 }
 317
 318 static void cmd_search(ZOOM_connection *c, ZOOM_resultset *r,
 319                        ZOOM_options options,
 320                        const char **args)
 321 {
 322     ZOOM_query s;
 323     const char *query_str = *args;
 324     int i;
 325
 326     s = ZOOM_query_create();
 327     while (*query_str == ' ')
 328         query_str++;
 329     if (memcmp(query_str, "cql:", 4) == 0)
 330     {
 331         ZOOM_query_cql(s, query_str + 4);
 332     }
 333     else if (ZOOM_query_prefix(s, query_str))
 334     {
 335         printf("Bad PQF: %s\n", query_str);
 336         return;
 337     }
 338     for (i = 0; i<MAX_CON; i++)
 339     {
 340
 341         if (c[i])
 342         {
 343             ZOOM_resultset_destroy(r[i]);
 344             r[i] = 0;
 345         }
 346         if (c[i])
 347             r[i] = ZOOM_connection_search(c[i], s);
 348     }
 349     ZOOM_query_destroy(s);
 350
 351     while (ZOOM_event(MAX_CON, c))
 352         ;
 353
 354     for (i = 0; i<MAX_CON; i++)
 355     {
 356         int error;
 357         const char *errmsg, *addinfo, *dset;
 358         /* display errors if any */
 359         if (!c[i])
 360             continue;
 361         if ((error = ZOOM_connection_error_x(c[i], &errmsg, &addinfo, &dset)))
 362             printf("%s error: %s (%s:%d) %s\n",
 363                    ZOOM_connection_option_get(c[i], "host"), errmsg,
 364                    dset, error, addinfo);
 365         else if (r[i])
 366         {
 367             /* OK, no major errors. Look at the result count */
 368             int start = ZOOM_options_get_int(options, "start", 0);
 369             int count = ZOOM_options_get_int(options, "count", 0);
 370
 371             printf("%s: %ld hits\n", ZOOM_connection_option_get(c[i], "host"),
 372                    (long) ZOOM_resultset_size(r[i]));
 373             /* and display */
 374             display_records(c[i], r[i], start, count);
 375         }
 376     }
 377 }
 378
 379 static void cmd_scan(ZOOM_connection *c, ZOOM_resultset *r,
 380                      ZOOM_options options,
 381                      const char **args)
 382 {
 383     const char *query_str = *args;
 384     ZOOM_query query = ZOOM_query_create();
 385     int i;
 386     ZOOM_scanset s[MAX_CON];
 387
 388     while (*query_str == ' ')
 389         query_str++;
 390
 391     if (memcmp(query_str, "cql:", 4) == 0)
 392     {
 393         ZOOM_query_cql(query, query_str + 4);
 394     }
 395     else if (ZOOM_query_prefix(query, query_str))
 396     {
 397         printf("Bad PQF: %s\n", query_str);
 398         return;
 399     }
 400
 401     for (i = 0; i<MAX_CON; i++)
 402     {
 403         if (c[i])
 404             s[i] = ZOOM_connection_scan1(c[i], query);
 405         else
 406             s[i] = 0;
 407     }
 408     ZOOM_query_destroy(query);
 409
 410     while (ZOOM_event(MAX_CON, c))
 411         ;
 412     for (i = 0; i<MAX_CON; i++)
 413     {
 414         int error;
 415         const char *errmsg, *addinfo, *dset;
 416         /* display errors if any */
 417         if (!c[i])
 418             continue;
 419         if ((error = ZOOM_connection_error_x(c[i], &errmsg, &addinfo, &dset)))
 420             printf("%s error: %s (%s:%d) %s\n",
 421                    ZOOM_connection_option_get(c[i], "host"), errmsg,
 422                    dset, error, addinfo);
 423
 424         if (s[i]) {
 425             size_t p, sz = ZOOM_scanset_size(s[i]);
 426             for (p = 0; p < sz; p++)
 427             {
 428                 int occ = 0;
 429                 int len = 0;
 430                 const char *term = ZOOM_scanset_display_term(s[i], p,
 431                                                              &occ, &len);
 432                 fwrite(term, 1, len, stdout);
 433                 printf(" %d\n", occ);
 434             }
 435             ZOOM_scanset_destroy(s[i]);
 436         }
 437     }
 438 }
 439
 440 static void cmd_sort(ZOOM_connection *c, ZOOM_resultset *r,
 441                      ZOOM_options options,
 442                      const char **args)
 443 {
 444     const char *sort_spec = *args;
 445     int i;
 446
 447     while (*sort_spec == ' ')
 448         sort_spec++;
 449
 450     for (i = 0; i<MAX_CON; i++)
 451     {
 452         if (r[i])
 453             ZOOM_resultset_sort(r[i], "yaz", sort_spec);
 454     }
 455     while (ZOOM_event(MAX_CON, c))
 456         ;
 457 }
 458
 459 static void cmd_help(ZOOM_connection *c, ZOOM_resultset *r,
 460                      ZOOM_options options,
 461                      const char **args)
 462 {
 463     printf("connect <zurl>\n");
 464     printf("search <pqf>\n");
 465     printf("show [<start> [<count>]\n");
 466     printf("scan <term>\n");
 467     printf("quit\n");
 468     printf("close <zurl>\n");
 469     printf("ext <type>\n");
 470     printf("set <option> [<value>]\n");
 471     printf("get <option>\n");
 472     printf("\n");
 473     printf("options:\n");
 474     printf(" start\n");
 475     printf(" count\n");
 476     printf(" databaseName\n");
 477     printf(" preferredRecordSyntax\n");
 478     printf(" proxy\n");
 479     printf(" elementSetName\n");
 480     printf(" maximumRecordSize\n");
 481     printf(" preferredRecordSize\n");
 482     printf(" async\n");
 483     printf(" piggyback\n");
 484     printf(" group\n");
 485     printf(" user\n");
 486     printf(" password\n");
 487     printf(" implementationName\n");
 488     printf(" charset\n");
 489     printf(" lang\n");
 490 }
 491
 492 static void cmd_connect(ZOOM_connection *c, ZOOM_resultset *r,
 493                         ZOOM_options options,
 494                         const char **args)
 495 {
 496     int error;
 497     const char *errmsg, *addinfo, *dset;
 498     char host[60];
 499     int j, i;
 500     if (next_token_copy(args, host, sizeof(host)) < 0)
 501     {
 502         printf("missing host after connect\n");
 503         return ;
 504     }
 505     for (j = -1, i = 0; i<MAX_CON; i++)
 506     {
 507         const char *h;
 508         if (c[i] && (h = ZOOM_connection_option_get(c[i], "host")) &&
 509             !strcmp(h, host))
 510         {
 511             ZOOM_connection_destroy(c[i]);
 512             break;
 513         }
 514         else if (c[i] == 0 && j == -1)
 515             j = i;
 516     }
 517     if (i == MAX_CON)  /* no match .. */
 518     {
 519         if (j == -1)
 520         {
 521             printf("no more connection available\n");
 522             return;
 523         }
 524         i = j;   /* OK, use this one is available */
 525     }
 526     c[i] = ZOOM_connection_create(options);
 527     ZOOM_connection_connect(c[i], host, 0);
 528
 529     if ((error = ZOOM_connection_error_x(c[i], &errmsg, &addinfo, &dset)))
 530         printf("%s error: %s (%s:%d) %s\n",
 531                ZOOM_connection_option_get(c[i], "host"), errmsg,
 532                dset, error, addinfo);
 533 }
 534
 535 static int cmd_parse(ZOOM_connection *c, ZOOM_resultset *r,
 536                      ZOOM_options options,
 537                      const char **buf)
 538 {
 539     int cmd_len;
 540     const char *cmd_str;
 541
 542     cmd_len = next_token(buf, &cmd_str);
 543     if (cmd_len < 0)
 544         return 1;
 545     if (is_command("quit", cmd_str, cmd_len))
 546         return 0;
 547     else if (is_command("set", cmd_str, cmd_len))
 548         cmd_set(c, r, options, buf);
 549     else if (is_command("get", cmd_str, cmd_len))
 550         cmd_get(c, r, options, buf);
 551     else if (is_command("rget", cmd_str, cmd_len))
 552         cmd_rget(c, r, options, buf);
 553     else if (is_command("connect", cmd_str, cmd_len))
 554         cmd_connect(c, r, options, buf);
 555     else if (is_command("open", cmd_str, cmd_len))
 556         cmd_connect(c, r, options, buf);
 557     else if (is_command("search", cmd_str, cmd_len))
 558         cmd_search(c, r, options, buf);
 559     else if (is_command("find", cmd_str, cmd_len))
 560         cmd_search(c, r, options, buf);
 561     else if (is_command("show", cmd_str, cmd_len))
 562         cmd_show(c, r, options, buf);
 563     else if (is_command("close", cmd_str, cmd_len))
 564         cmd_close(c, r, options, buf);
 565     else if (is_command("help", cmd_str, cmd_len))
 566         cmd_help(c, r, options, buf);
 567     else if (is_command("ext", cmd_str, cmd_len))
 568         cmd_ext(c, r, options, buf);
 569     else if (is_command("debug", cmd_str, cmd_len))
 570         cmd_debug(c, r, options, buf);
 571     else if (is_command("scan", cmd_str, cmd_len))
 572         cmd_scan(c, r, options, buf);
 573     else if (is_command("sort", cmd_str, cmd_len))
 574         cmd_sort(c, r, options, buf);
 575     else
 576         printf("unknown command %.*s\n", cmd_len, cmd_str);
 577     return 2;
 578 }
 579
 580 void shell(ZOOM_connection *c, ZOOM_resultset *r,
 581            ZOOM_options options)
 582 {
 583     while (1)
 584     {
 585         char buf[1000];
 586         char *cp;
 587         const char *bp = buf;
 588 #if HAVE_READLINE_READLINE_H
 589         char* line_in;
 590         line_in=readline("ZOOM>");
 591         if (!line_in)
 592             break;
 593 #if HAVE_READLINE_HISTORY_H
 594         if (*line_in)
 595             add_history(line_in);
 596 #endif
 597         if(strlen(line_in) > 999) {
 598             printf("Input line too long\n");
 599             break;
 600         };
 601         strcpy(buf,line_in);
 602         free(line_in);
 603 #else
 604         printf("ZOOM>"); fflush(stdout);
 605         if (!fgets(buf, 999, stdin))
 606             break;
 607 #endif
 608         if ((cp = strchr(buf, '\n')))
 609             *cp = '\0';
 610         if (!cmd_parse(c, r, options, &bp))
 611             break;
 612     }
 613 }
 614
 615 static void zoomsh(int argc, char **argv)
 616 {
 617     ZOOM_options options = ZOOM_options_create();
 618     int i, res;
 619     ZOOM_connection z39_con[MAX_CON];
 620     ZOOM_resultset  z39_res[MAX_CON];
 621
 622     for (i = 0; i<MAX_CON; i++)
 623     {
 624         z39_con[i] = 0;
 625         z39_res[i] = 0;
 626     }
 627
 628     for (i = 0; i<MAX_CON; i++)
 629         z39_con[i] = 0;
 630
 631     res = 1;
 632     for (i = 1; i<argc; i++)
 633     {
 634         const char *bp = argv[i];
 635         res = cmd_parse(z39_con, z39_res, options, &bp);
 636         if (res == 0)  /* received quit */
 637             break;
 638     }
 639     if (res)  /* do cmdline shell only if not quitting */
 640         shell(z39_con, z39_res, options);
 641     ZOOM_options_destroy(options);
 642
 643     for (i = 0; i<MAX_CON; i++)
 644     {
 645         ZOOM_connection_destroy(z39_con[i]);
 646         ZOOM_resultset_destroy(z39_res[i]);
 647     }
 648 }
 649
 650 int main(int argc, char **argv)
 651 {
 652     const char *maskstr = 0;
 653     if (argc > 2 && !strcmp(argv[1], "-v"))
 654     {
 655         maskstr = argv[2];
 656         argv += 2;
 657         argc -= 2;
 658     }
 659     else if (argc > 1 && !strncmp(argv[1], "-v", 2))
 660     {
 661         maskstr = argv[1]+2;
 662         argv++;
 663         argc--;
 664     }
 665     if (maskstr)
 666     {
 667         int mask = yaz_log_mask_str(maskstr);
 668         yaz_log_init_level(mask);
 669     }
 670     zoomsh(argc, argv);
 671     exit(0);
 672 }
 673 /*
 674  * Local variables:
 675  * c-basic-offset: 4
 676  * indent-tabs-mode: nil
 677  * End:
 678  * vim: shiftwidth=4 tabstop=8 expandtab
 679  */
 680