src/yaz-my-client.cpp

   1 /*
   2  * Copyright (c) 1998-2004, Index Data.
   3  * See the file LICENSE for details.
   4  *
   5  * $Id: yaz-my-client.cpp,v 1.25 2007-03-20 07:54:11 adam Exp $
   6  */
   7
   8 #include <stdlib.h>
   9 #include <yaz/log.h>
  10 #include <yaz/options.h>
  11 #include <yaz/diagbib1.h>
  12 #include <yaz/marcdisp.h>
  13 #include <yazpp/ir-assoc.h>
  14 #include <yazpp/pdu-assoc.h>
  15 #include <yazpp/socket-manager.h>
  16
  17 extern "C" {
  18 #if HAVE_READLINE_READLINE_H
  19 #include <readline/readline.h>
  20 #endif
  21 #if HAVE_READLINE_HISTORY_H
  22 #include <readline/history.h>
  23 #endif
  24 }
  25
  26 using namespace yazpp_1;
  27
  28 class YAZ_EXPORT MyClient : public IR_Assoc {
  29 private:
  30     int m_interactive_flag;
  31     char m_thisCommand[1024];
  32     char m_lastCommand[1024];
  33     int m_setOffset;
  34     SocketManager *m_socketManager;
  35 public:
  36     MyClient(IPDU_Observable *the_PDU_Observable,
  37              SocketManager *the_SocketManager);
  38     IPDU_Observer *sessionNotify(
  39         IPDU_Observable *the_PDU_Observable, int fd);
  40     int args(SocketManager *socketManager, int argc, char **argv);
  41     int interactive(SocketManager *socketManager);
  42     int wait();
  43     void recv_initResponse(Z_InitResponse *initResponse);
  44     void recv_searchResponse(Z_SearchResponse *searchResponse);
  45     void recv_presentResponse(Z_PresentResponse *presentResponse);
  46     void recv_records (Z_Records *records);
  47     void recv_diagrecs(Z_DiagRec **pp, int num);
  48     void recv_namePlusRecord (Z_NamePlusRecord *zpr, int offset);
  49     void recv_record(Z_DatabaseRecord *record, int offset,
  50                      const char *databaseName);
  51     void recv_textRecord(int type, const char *buf, size_t len);
  52     void recv_genericRecord(Z_GenericRecord *r);
  53     void display_genericRecord(Z_GenericRecord *r, int level);
  54     void display_variant(Z_Variant *v, int level);
  55     void connectNotify();
  56     void failNotify();
  57     void timeoutNotify();
  58     char *get_cookie (Z_OtherInformation **oi);
  59     int processCommand(const char *cmd);
  60     const char *getCommand();
  61     int cmd_open(char *host);
  62     int cmd_connect(char *host);
  63     int cmd_quit(char *args);
  64     int cmd_close(char *args);
  65     int cmd_find(char *args);
  66     int cmd_show(char *args);
  67     int cmd_cookie(char *args);
  68     int cmd_init(char *args);
  69     int cmd_format(char *args);
  70     int cmd_proxy(char *args);
  71 };
  72
  73
  74 void MyClient::connectNotify()
  75 {
  76     printf ("Connection accepted by target\n");
  77     set_lastReceived(-1);
  78 }
  79
  80 void MyClient::timeoutNotify()
  81 {
  82     printf ("Connection timeout\n");
  83     close();
  84 }
  85
  86 void MyClient::failNotify()
  87 {
  88     printf ("Connection closed by target\n");
  89     set_lastReceived(-1);
  90 }
  91
  92 IPDU_Observer *MyClient::sessionNotify(IPDU_Observable *the_PDU_Observable,
  93                                        int fd)
  94 {
  95     return new MyClient(the_PDU_Observable, m_socketManager);
  96 }
  97
  98 MyClient::MyClient(IPDU_Observable *the_PDU_Observable,
  99                    SocketManager *the_socketManager) :
 100     IR_Assoc (the_PDU_Observable)
 101 {
 102     m_setOffset = 1;
 103     m_interactive_flag = 1;
 104     m_thisCommand[0] = '\0';
 105     m_lastCommand[0] = '\0';
 106     m_socketManager = the_socketManager;
 107 }
 108
 109 void usage(char *prog)
 110 {
 111     fprintf (stderr, "%s: [-v log] [-c cookie] [-p proxy] [zurl]\n", prog);
 112     exit (1);
 113 }
 114
 115 char *MyClient::get_cookie(Z_OtherInformation **otherInfo)
 116 {
 117     int oid[OID_SIZE];
 118     Z_OtherInformationUnit *oi;
 119     struct oident ent;
 120     ent.proto = PROTO_Z3950;
 121     ent.oclass = CLASS_USERINFO;
 122     ent.value = (oid_value) VAL_COOKIE;
 123
 124     if (oid_ent_to_oid (&ent, oid) &&
 125         (oi = update_otherInformation(otherInfo, 0, oid, 1, 1)) &&
 126         oi->which == Z_OtherInfo_characterInfo)
 127         return oi->information.characterInfo;
 128     return 0;
 129 }
 130
 131 void MyClient::recv_initResponse(Z_InitResponse *initResponse)
 132 {
 133     printf ("Got InitResponse. Status ");
 134     if (*initResponse->result)
 135     {
 136         printf ("Ok\n");
 137
 138         const char *p = get_cookie (&initResponse->otherInfo);
 139         if (p)
 140         {
 141             printf ("cookie = %s\n", p);
 142             set_cookie(p);
 143         }
 144     }
 145     else
 146         printf ("Fail\n");
 147 }
 148
 149 void MyClient::recv_diagrecs(Z_DiagRec **pp, int num)
 150 {
 151     int i;
 152     oident *ent;
 153     Z_DefaultDiagFormat *r;
 154
 155     printf("Diagnostic message(s) from database:\n");
 156     for (i = 0; i<num; i++)
 157     {
 158         Z_DiagRec *p = pp[i];
 159         if (p->which != Z_DiagRec_defaultFormat)
 160         {
 161             printf("Diagnostic record not in default format.\n");
 162             return;
 163         }
 164         else
 165             r = p->u.defaultFormat;
 166         if (!(ent = oid_getentbyoid(r->diagnosticSetId)) ||
 167             ent->oclass != CLASS_DIAGSET || ent->value != VAL_BIB1)
 168             printf("Missing or unknown diagset\n");
 169         printf("    [%d] %s", *r->condition, diagbib1_str(*r->condition));
 170 #ifdef ASN_COMPILED
 171         switch (r->which)
 172         {
 173         case Z_DefaultDiagFormat_v2Addinfo:
 174             printf (" -- v2 addinfo '%s'\n", r->u.v2Addinfo);
 175             break;
 176         case Z_DefaultDiagFormat_v3Addinfo:
 177             printf (" -- v3 addinfo '%s'\n", r->u.v3Addinfo);
 178             break;
 179         }
 180 #else
 181         if (r->addinfo && *r->addinfo)
 182             printf(" -- '%s'\n", r->addinfo);
 183         else
 184             printf("\n");
 185 #endif
 186     }
 187 }
 188
 189 void MyClient::recv_textRecord(int type, const char *buf, size_t len)
 190 {
 191     fwrite (buf, 1, len, stdout);
 192     fputc ('\n', stdout);
 193 }
 194
 195 void MyClient::display_variant(Z_Variant *v, int level)
 196 {
 197     int i;
 198
 199     for (i = 0; i < v->num_triples; i++)
 200     {
 201         printf("%*sclass=%d,type=%d", level * 4, "", *v->triples[i]->zclass,
 202             *v->triples[i]->type);
 203         if (v->triples[i]->which == Z_Triple_internationalString)
 204             printf(",value=%s\n", v->triples[i]->value.internationalString);
 205         else
 206             printf("\n");
 207     }
 208 }
 209
 210 void MyClient::display_genericRecord(Z_GenericRecord *r, int level)
 211 {
 212     int i;
 213
 214     if (!r)
 215         return;
 216     for (i = 0; i < r->num_elements; i++)
 217     {
 218         Z_TaggedElement *t;
 219
 220         printf("%*s", level * 4, "");
 221         t = r->elements[i];
 222         printf("(");
 223         if (t->tagType)
 224             printf("%d,", *t->tagType);
 225         else
 226             printf("?,");
 227         if (t->tagValue->which == Z_StringOrNumeric_numeric)
 228             printf("%d) ", *t->tagValue->u.numeric);
 229         else
 230             printf("%s) ", t->tagValue->u.string);
 231         if (t->content->which == Z_ElementData_subtree)
 232         {
 233             printf("\n");
 234             display_genericRecord(t->content->u.subtree, level+1);
 235         }
 236         else if (t->content->which == Z_ElementData_string)
 237             printf("%s\n", t->content->u.string);
 238         else if (t->content->which == Z_ElementData_numeric)
 239             printf("%d\n", *t->content->u.numeric);
 240         else if (t->content->which == Z_ElementData_oid)
 241         {
 242             int *ip = t->content->u.oid;
 243             oident *oent;
 244
 245             if ((oent = oid_getentbyoid(t->content->u.oid)))
 246                 printf("OID: %s\n", oent->desc);
 247             else
 248             {
 249                 printf("{");
 250                 while (ip && *ip >= 0)
 251                     printf(" %d", *(ip++));
 252                 printf(" }\n");
 253             }
 254         }
 255         else if (t->content->which == Z_ElementData_noDataRequested)
 256             printf("[No data requested]\n");
 257         else if (t->content->which == Z_ElementData_elementEmpty)
 258             printf("[Element empty]\n");
 259         else if (t->content->which == Z_ElementData_elementNotThere)
 260             printf("[Element not there]\n");
 261         else
 262             printf("??????\n");
 263         if (t->appliedVariant)
 264             display_variant(t->appliedVariant, level+1);
 265         if (t->metaData && t->metaData->supportedVariants)
 266         {
 267             int c;
 268
 269             printf("%*s---- variant list\n", (level+1)*4, "");
 270             for (c = 0; c < t->metaData->num_supportedVariants; c++)
 271             {
 272                 printf("%*svariant #%d\n", (level+1)*4, "", c);
 273                 display_variant(t->metaData->supportedVariants[c], level + 2);
 274             }
 275         }
 276     }
 277 }
 278
 279 void MyClient::recv_genericRecord(Z_GenericRecord *r)
 280 {
 281     display_genericRecord(r, 0);
 282 }
 283
 284 void MyClient::recv_record(Z_DatabaseRecord *record, int offset,
 285                            const char *databaseName)
 286 {
 287     Z_External *r = (Z_External*) record;
 288     oident *ent = oid_getentbyoid(r->direct_reference);
 289
 290     /*
 291      * Tell the user what we got.
 292      */
 293     if (r->direct_reference)
 294     {
 295         printf("Record type: ");
 296         if (ent)
 297             printf("%s\n", ent->desc);
 298     }
 299     /* Check if this is a known, ASN.1 type tucked away in an octet string */
 300     Z_ext_typeent *etype = z_ext_getentbyref(ent->value);
 301     if (ent && (r->which == Z_External_octet || r->which == Z_External_single)
 302         && (etype = z_ext_getentbyref(ent->value)))
 303
 304     {
 305         void *rr;
 306         /*
 307          * Call the given decoder to process the record.
 308          */
 309         odr_setbuf(odr_decode(), (char*)record->u.octet_aligned->buf,
 310                    record->u.octet_aligned->len, 0);
 311         if (!(*etype->fun)(odr_decode(), (char **)&rr, 0, 0))
 312         {
 313             odr_perror(odr_decode(), "Decoding constructed record.");
 314             fprintf(stderr, "[Near %ld]\n", (long) odr_offset(odr_decode()));
 315             fprintf(stderr, "Packet dump:\n---------\n");
 316             odr_dumpBER(stderr, (char*)record->u.octet_aligned->buf,
 317                         record->u.octet_aligned->len);
 318             fprintf(stderr, "---------\n");
 319         }
 320         if (etype->what == Z_External_sutrs)
 321         {
 322             Z_SUTRS *sutrs = (Z_SUTRS *) rr;
 323             recv_textRecord ((int) VAL_SUTRS, (const char *) sutrs->buf,
 324                              (size_t) sutrs->len);
 325         }
 326         return;
 327     }
 328     if (r->which == Z_External_octet && record->u.octet_aligned->len)
 329     {
 330         yaz_marc_t mt = yaz_marc_create();
 331         switch (ent->value)
 332         {
 333         case VAL_ISO2709:
 334         case VAL_UNIMARC:
 335         case VAL_INTERMARC:
 336         case VAL_USMARC:
 337         case VAL_UKMARC:
 338         case VAL_NORMARC:
 339         case VAL_LIBRISMARC:
 340         case VAL_DANMARC:
 341         case VAL_FINMARC:
 342         case VAL_MAB:
 343         case VAL_CANMARC:
 344         case VAL_SBN:
 345         case VAL_PICAMARC:
 346         case VAL_AUSMARC:
 347         case VAL_IBERMARC:
 348         case VAL_CATMARC:
 349         case VAL_MALMARC:
 350         case VAL_JPMARC:
 351         case VAL_SWEMARC:
 352         case VAL_SIGLEMARC:
 353         case VAL_ISDSMARC:
 354         case VAL_RUSMARC:
 355             const char *result_buf;
 356             size_t result_size;
 357             yaz_marc_decode_buf(mt, (const char *)
 358                                 record->u.octet_aligned->buf,
 359                                 record->u.octet_aligned->len,
 360                                 &result_buf, &result_size);
 361             fwrite(result_buf, 1, result_size, stdout);
 362             break;
 363         default:
 364             recv_textRecord((int) ent->value,
 365                             (const char *) record->u.octet_aligned->buf,
 366                             (size_t) record->u.octet_aligned->len);
 367         }
 368         yaz_marc_destroy(mt);
 369     }
 370     else if (ent && ent->value == VAL_SUTRS && r->which == Z_External_sutrs)
 371         recv_textRecord((int) VAL_SUTRS, (const char *) r->u.sutrs->buf,
 372                         (size_t) r->u.sutrs->len);
 373     else if (ent && ent->value == VAL_GRS1 && r->which == Z_External_grs1)
 374         recv_genericRecord(r->u.grs1);
 375     else
 376     {
 377         printf("Unknown record representation.\n");
 378         if (!z_External(odr_print(), &r, 0, 0))
 379         {
 380             odr_perror(odr_print(), "Printing external");
 381             odr_reset(odr_print());
 382         }
 383     }
 384 }
 385
 386 void MyClient::recv_namePlusRecord (Z_NamePlusRecord *zpr, int offset)
 387 {
 388     if (zpr->databaseName)
 389         printf("[%s]", zpr->databaseName);
 390     if (zpr->which == Z_NamePlusRecord_surrogateDiagnostic)
 391         recv_diagrecs(&zpr->u.surrogateDiagnostic, 1);
 392     else
 393         recv_record(zpr->u.databaseRecord, offset, zpr->databaseName);
 394 }
 395
 396 void MyClient::recv_records (Z_Records *records)
 397 {
 398 #ifdef ASN_COMPILED
 399     Z_DiagRec dr, *dr_p = &dr;
 400 #endif
 401     if (!records)
 402         return;
 403     int i;
 404     switch (records->which)
 405     {
 406     case Z_Records_DBOSD:
 407         for (i = 0; i < records->u.databaseOrSurDiagnostics->num_records; i++)
 408             recv_namePlusRecord(records->u.databaseOrSurDiagnostics->
 409                                 records[i], i + m_setOffset);
 410         m_setOffset += records->u.databaseOrSurDiagnostics->num_records;
 411         break;
 412     case Z_Records_NSD:
 413 #ifdef ASN_COMPILED
 414         dr.which = Z_DiagRec_defaultFormat;
 415         dr.u.defaultFormat = records->u.nonSurrogateDiagnostic;
 416         recv_diagrecs (&dr_p, 1);
 417 #else
 418         recv_diagrecs (&records->u.nonSurrogateDiagnostic, 1);
 419 #endif
 420         break;
 421     case Z_Records_multipleNSD:
 422         recv_diagrecs (records->u.multipleNonSurDiagnostics->diagRecs,
 423                        records->u.multipleNonSurDiagnostics->num_diagRecs);
 424         break;
 425     }
 426 }
 427
 428 void MyClient::recv_searchResponse(Z_SearchResponse *searchResponse)
 429 {
 430     printf ("Got SearchResponse. Status ");
 431     if (!*searchResponse->searchStatus)
 432     {
 433         printf ("Fail\n");
 434     }
 435     else
 436     {
 437         printf ("Ok\n");
 438         printf ("Hits: %d\n", *searchResponse->resultCount);
 439     }
 440     recv_records (searchResponse->records);
 441 }
 442
 443 void MyClient::recv_presentResponse(Z_PresentResponse *presentResponse)
 444 {
 445     printf ("Got PresentResponse\n");
 446     recv_records (presentResponse->records);
 447 }
 448
 449 int MyClient::wait()
 450 {
 451     set_lastReceived(0);
 452     while (m_socketManager->processEvent() > 0)
 453     {
 454         if (get_lastReceived())
 455             return 1;
 456     }
 457     return 0;
 458 }
 459
 460
 461 #define C_PROMPT "Z>"
 462
 463 int MyClient::cmd_connect(char *host)
 464 {
 465     client (host);
 466     timeout (10);
 467     wait ();
 468     timeout (-1);
 469     return 1;
 470 }
 471
 472 int MyClient::cmd_open(char *host)
 473 {
 474     client (host);
 475     timeout (10);
 476     wait ();
 477     timeout (-1);
 478     send_initRequest();
 479     wait ();
 480     return 1;
 481 }
 482
 483 int MyClient::cmd_init(char *args)
 484 {
 485     if (send_initRequest() >= 0)
 486         wait();
 487     else
 488         close();
 489     return 1;
 490 }
 491
 492 int MyClient::cmd_quit(char *args)
 493 {
 494     return 0;
 495 }
 496
 497 int MyClient::cmd_close(char *args)
 498 {
 499     close();
 500     return 1;
 501 }
 502
 503 int MyClient::cmd_find(char *args)
 504 {
 505     Yaz_Z_Query query;
 506
 507     if (query.set_rpn(args) <= 0)
 508     {
 509         printf ("Bad RPN query\n");
 510         return 1;
 511     }
 512     if (send_searchRequest(&query) >= 0)
 513         wait();
 514     else
 515         printf ("Not connected\n");
 516     return 1;
 517 }
 518
 519 int MyClient::cmd_show(char *args)
 520 {
 521     int start = m_setOffset, number = 1;
 522
 523     sscanf (args, "%d %d", &start, &number);
 524     m_setOffset = start;
 525     if (send_presentRequest(start, number) >= 0)
 526         wait();
 527     else
 528         printf ("Not connected\n");
 529     return 1;
 530 }
 531
 532 int MyClient::cmd_cookie(char *args)
 533 {
 534     set_cookie(*args ? args : 0);
 535     return 1;
 536 }
 537
 538 int MyClient::cmd_format(char *args)
 539 {
 540     set_preferredRecordSyntax(args);
 541     return 1;
 542 }
 543
 544 int MyClient::cmd_proxy(char *args)
 545 {
 546     set_proxy(args);
 547     return 1;
 548 }
 549
 550 int MyClient::processCommand(const char *commandLine)
 551 {
 552     char cmdStr[1024], cmdArgs[1024];
 553     cmdArgs[0] = '\0';
 554     cmdStr[0] = '\0';
 555     static struct {
 556         const char *cmd;
 557         int (MyClient::*fun)(char *arg);
 558         const char *ad;
 559     } cmd[] = {
 560         {"open", &MyClient::cmd_open, "<host>[':'<port>][/<database>]"},
 561         {"connect", &MyClient::cmd_connect, "<host>[':'<port>][/<database>]"},
 562         {"quit", &MyClient::cmd_quit, ""},
 563         {"close", &MyClient::cmd_close, ""},
 564         {"find", &MyClient::cmd_find, "<query>"},
 565         {"show", &MyClient::cmd_show, "[<start> [<number>]]"},
 566         {"cookie", &MyClient::cmd_cookie, "<cookie>"},
 567         {"init", &MyClient::cmd_init, ""},
 568         {"format", &MyClient::cmd_format, "<record-syntax>"},
 569         {"proxy", &MyClient::cmd_proxy, "<host>:[':'<port>]"},
 570         {0,0,0}
 571     };
 572
 573     if (sscanf(commandLine, "%s %[^;]", cmdStr, cmdArgs) < 1)
 574         return 1;
 575     int i;
 576     for (i = 0; cmd[i].cmd; i++)
 577         if (!strncmp(cmd[i].cmd, cmdStr, strlen(cmdStr)))
 578             break;
 579
 580     int res = 1;
 581     if (cmd[i].cmd) // Invoke command handler
 582         res = (this->*cmd[i].fun)(cmdArgs);
 583     else            // Dump help screen
 584     {
 585         printf("Unknown command: %s.\n", cmdStr);
 586         printf("Currently recognized commands:\n");
 587         for (i = 0; cmd[i].cmd; i++)
 588             printf("   %s %s\n", cmd[i].cmd, cmd[i].ad);
 589     }
 590     return res;
 591 }
 592
 593 const char *MyClient::getCommand()
 594 {
 595 #if HAVE_READLINE_READLINE_H
 596     // Read using GNU readline
 597     char *line_in;
 598     line_in=readline(C_PROMPT);
 599     if (!line_in)
 600         return 0;
 601 #if HAVE_READLINE_HISTORY_H
 602     if (*line_in)
 603         add_history(line_in);
 604 #endif
 605     strncpy(m_thisCommand,line_in, 1023);
 606     m_thisCommand[1023] = '\0';
 607     free (line_in);
 608 #else
 609     // Read using fgets(3)
 610     printf (C_PROMPT);
 611     fflush(stdout);
 612     if (!fgets(m_thisCommand, 1023, stdin))
 613         return 0;
 614 #endif
 615     // Remove trailing whitespace
 616     char *cp = m_thisCommand + strlen(m_thisCommand);
 617     while (cp != m_thisCommand && strchr("\t \n", cp[-1]))
 618         cp--;
 619     *cp = '\0';
 620     cp = m_thisCommand;
 621     // Remove leading spaces...
 622     while (*cp && strchr ("\t \n", *cp))
 623         cp++;
 624     // Save command if non-empty
 625     if (*cp != '\0')
 626         strcpy (m_lastCommand, cp);
 627     return m_lastCommand;
 628 }
 629
 630 int MyClient::interactive(SocketManager *socketManager)
 631 {
 632     const char *cmd;
 633     if (!m_interactive_flag)
 634         return 0;
 635     while ((cmd = getCommand()))
 636     {
 637         if (!processCommand(cmd))
 638             break;
 639     }
 640     return 0;
 641 }
 642
 643 int MyClient::args(SocketManager *socketManager, int argc, char **argv)
 644 {
 645     char *host = 0;
 646     char *proxy = 0;
 647     char *arg;
 648     char *prog = argv[0];
 649     int ret;
 650
 651     while ((ret = options("c:p:v:q", argv, argc, &arg)) != -2)
 652     {
 653         switch (ret)
 654         {
 655         case 0:
 656             if (host)
 657             {
 658                 usage(prog);
 659                 return 1;
 660             }
 661             host = arg;
 662             break;
 663         case 'p':
 664             if (proxy)
 665             {
 666                 usage(prog);
 667                 return 1;
 668             }
 669             set_proxy(arg);
 670             break;
 671         case 'c':
 672             set_cookie(arg);
 673             break;
 674         case 'v':
 675             yaz_log_init_level (yaz_log_mask_str(arg));
 676             break;
 677         case 'q':
 678             m_interactive_flag = 0;
 679             break;
 680         default:
 681             usage(prog);
 682             return 1;
 683         }
 684     }
 685     if (host)
 686     {
 687         client (host);
 688         timeout (10);
 689         wait ();
 690         timeout (-1);
 691         send_initRequest();
 692         wait ();
 693     }
 694     return 0;
 695 }
 696
 697 int main(int argc, char **argv)
 698 {
 699     SocketManager mySocketManager;
 700     PDU_Assoc *some = new PDU_Assoc(&mySocketManager);
 701
 702     MyClient z(some, &mySocketManager);
 703
 704     if (z.args(&mySocketManager, argc, argv))
 705         exit (1);
 706     if (z.interactive(&mySocketManager))
 707         exit (1);
 708     return 0;
 709 }
 710 /*
 711  * Local variables:
 712  * c-basic-offset: 4
 713  * indent-tabs-mode: nil
 714  * End:
 715  * vim: shiftwidth=4 tabstop=8 expandtab
 716  */
 717