2 * Copyright (c) 1998-2000, Index Data.
3 * See the file LICENSE for details.
5 * $Log: yaz-my-client.cpp,v $
6 * Revision 1.4 2001-04-05 15:12:24 adam
9 * Revision 1.3 2001/04/05 13:09:44 adam
10 * Removed ursula dependancy.
12 * Revision 1.2 2001/04/04 14:02:49 adam
13 * URSULA / Z-ruth service.
15 * Revision 1.1 2001/03/27 14:47:45 adam
16 * New server facility scheme.
18 * Revision 1.17 2001/03/26 14:43:49 adam
19 * New threaded PDU association.
21 * Revision 1.16 2000/11/01 14:22:59 adam
22 * Added fd parameter for method IYaz_PDU_Observer::clone.
24 * Revision 1.15 2000/10/11 11:58:16 adam
25 * Moved header files to include/yaz++. Switched to libtool and automake.
26 * Configure script creates yaz++-config script.
28 * Revision 1.14 2000/09/08 10:23:42 adam
29 * Added skeleton of yaz-z-server.
31 * Revision 1.13 2000/09/06 14:23:45 adam
34 * Revision 1.12 2000/09/04 08:59:16 adam
35 * Changed call to logging functions (yaz_ added).
37 * Revision 1.11 2000/07/04 13:48:49 adam
38 * Implemented upper-limit on proxy-to-target sessions.
40 * Revision 1.10 2000/05/30 03:12:27 ian
41 * minor change to stop g++ 2.95.2 complaining about taking the address
42 * of a member function.
44 * Revision 1.9 1999/12/06 13:52:45 adam
45 * Modified for new location of YAZ header files. Experimental threaded
48 * Revision 1.8 1999/11/10 10:02:34 adam
51 * Revision 1.7 1999/04/21 12:09:01 adam
52 * Many improvements. Modified to proxy server to work with "sessions"
55 * Revision 1.6 1999/04/20 10:30:05 adam
56 * Implemented various stuff for client and proxy. Updated calls
57 * to ODR to reflect new name parameter.
59 * Revision 1.5 1999/04/09 11:46:57 adam
60 * Added object Yaz_Z_Assoc. Much more functional client.
62 * Revision 1.4 1999/03/23 14:17:57 adam
63 * More work on timeout handling. Work on yaz-client.
65 * Revision 1.3 1999/02/02 14:01:18 adam
66 * First WIN32 port of YAZ++.
68 * Revision 1.2 1999/01/28 13:08:42 adam
69 * Yaz_PDU_Assoc better encapsulated. Memory leak fix in
70 * yaz-socket-manager.cc.
72 * Revision 1.1.1.1 1999/01/28 09:41:07 adam
73 * First implementation of YAZ++.
78 #include <yaz/options.h>
79 #include <yaz/diagbib1.h>
80 #include <yaz/marcdisp.h>
81 #include <yaz++/yaz-ir-assoc.h>
82 #include <yaz++/yaz-pdu-assoc.h>
83 #include <yaz++/yaz-socket-manager.h>
86 #include <yaz/zes-ursula.h>
90 #if HAVE_READLINE_READLINE_H
91 #include <readline/readline.h>
93 #if HAVE_READLINE_HISTORY_H
94 #include <readline/history.h>
98 class YAZ_EXPORT MyClient : public Yaz_IR_Assoc {
100 int m_interactive_flag;
101 char m_thisCommand[1024];
102 char m_lastCommand[1024];
104 Yaz_SocketManager *m_socketManager;
106 MyClient(IYaz_PDU_Observable *the_PDU_Observable,
107 Yaz_SocketManager *the_SocketManager);
108 IYaz_PDU_Observer *sessionNotify(
109 IYaz_PDU_Observable *the_PDU_Observable, int fd);
110 int args(Yaz_SocketManager *socketManager, int argc, char **argv);
111 int interactive(Yaz_SocketManager *socketManager);
113 void recv_initResponse(Z_InitResponse *initResponse);
114 void recv_searchResponse(Z_SearchResponse *searchResponse);
115 void recv_presentResponse(Z_PresentResponse *presentResponse);
116 void recv_records (Z_Records *records);
117 void recv_diagrecs(Z_DiagRec **pp, int num);
118 void recv_namePlusRecord (Z_NamePlusRecord *zpr, int offset);
119 void recv_record(Z_DatabaseRecord *record, int offset,
120 const char *databaseName);
121 void recv_textRecord(int type, const char *buf, size_t len);
122 void recv_genericRecord(Z_GenericRecord *r);
123 void display_genericRecord(Z_GenericRecord *r, int level);
124 void display_variant(Z_Variant *v, int level);
125 void connectNotify();
127 void timeoutNotify();
128 char *get_cookie (Z_OtherInformation **oi);
129 int processCommand(const char *cmd);
130 const char *MyClient::getCommand();
131 int cmd_open(char *host);
132 int cmd_connect(char *host);
133 int cmd_quit(char *args);
134 int cmd_close(char *args);
135 int cmd_find(char *args);
136 int cmd_show(char *args);
137 int cmd_cookie(char *args);
138 int cmd_init(char *args);
139 int cmd_format(char *args);
140 int cmd_proxy(char *args);
141 #if HAVE_YAZ_URSULA_H
142 int cmd_ursula(char *args);
147 void MyClient::connectNotify()
149 printf ("Connection accepted by target\n");
150 set_lastReceived(-1);
153 void MyClient::timeoutNotify()
155 printf ("Connection timeout\n");
159 void MyClient::failNotify()
161 printf ("Connection closed by target\n");
162 set_lastReceived(-1);
165 IYaz_PDU_Observer *MyClient::sessionNotify(
166 IYaz_PDU_Observable *the_PDU_Observable, int fd)
168 return new MyClient(the_PDU_Observable, m_socketManager);
171 MyClient::MyClient(IYaz_PDU_Observable *the_PDU_Observable,
172 Yaz_SocketManager *the_socketManager) :
173 Yaz_IR_Assoc (the_PDU_Observable)
176 m_interactive_flag = 1;
177 m_thisCommand[0] = '\0';
178 m_lastCommand[0] = '\0';
179 m_socketManager = the_socketManager;
182 void usage(char *prog)
184 fprintf (stderr, "%s: [-v log] [-c cookie] [-p proxy] [zurl]\n", prog);
188 char *MyClient::get_cookie(Z_OtherInformation **otherInfo)
191 Z_OtherInformationUnit *oi;
193 ent.proto = PROTO_Z3950;
194 ent.oclass = CLASS_USERINFO;
195 ent.value = (oid_value) VAL_COOKIE;
197 if (oid_ent_to_oid (&ent, oid) &&
198 (oi = update_otherInformation(otherInfo, 0, oid, 1, 1)) &&
199 oi->which == Z_OtherInfo_characterInfo)
200 return oi->information.characterInfo;
204 void MyClient::recv_initResponse(Z_InitResponse *initResponse)
206 printf ("Got InitResponse. Status ");
207 if (*initResponse->result)
211 const char *p = get_cookie (&initResponse->otherInfo);
214 printf ("cookie = %s\n", p);
222 void MyClient::recv_diagrecs(Z_DiagRec **pp, int num)
226 Z_DefaultDiagFormat *r;
228 printf("Diagnostic message(s) from database:\n");
229 for (i = 0; i<num; i++)
231 Z_DiagRec *p = pp[i];
232 if (p->which != Z_DiagRec_defaultFormat)
234 printf("Diagnostic record not in default format.\n");
238 r = p->u.defaultFormat;
239 if (!(ent = oid_getentbyoid(r->diagnosticSetId)) ||
240 ent->oclass != CLASS_DIAGSET || ent->value != VAL_BIB1)
241 printf("Missing or unknown diagset\n");
242 printf(" [%d] %s", *r->condition, diagbib1_str(*r->condition));
246 case Z_DefaultDiagFormat_v2Addinfo:
247 printf (" -- v2 addinfo '%s'\n", r->u.v2Addinfo);
249 case Z_DefaultDiagFormat_v3Addinfo:
250 printf (" -- v3 addinfo '%s'\n", r->u.v3Addinfo);
254 if (r->addinfo && *r->addinfo)
255 printf(" -- '%s'\n", r->addinfo);
262 void MyClient::recv_textRecord(int type, const char *buf, size_t len)
264 fwrite (buf, 1, len, stdout);
265 fputc ('\n', stdout);
268 void MyClient::display_variant(Z_Variant *v, int level)
272 for (i = 0; i < v->num_triples; i++)
274 printf("%*sclass=%d,type=%d", level * 4, "", *v->triples[i]->zclass,
275 *v->triples[i]->type);
276 if (v->triples[i]->which == Z_Triple_internationalString)
277 printf(",value=%s\n", v->triples[i]->value.internationalString);
283 void MyClient::display_genericRecord(Z_GenericRecord *r, int level)
289 for (i = 0; i < r->num_elements; i++)
293 printf("%*s", level * 4, "");
297 printf("%d,", *t->tagType);
300 if (t->tagValue->which == Z_StringOrNumeric_numeric)
301 printf("%d) ", *t->tagValue->u.numeric);
303 printf("%s) ", t->tagValue->u.string);
304 if (t->content->which == Z_ElementData_subtree)
307 display_genericRecord(t->content->u.subtree, level+1);
309 else if (t->content->which == Z_ElementData_string)
310 printf("%s\n", t->content->u.string);
311 else if (t->content->which == Z_ElementData_numeric)
312 printf("%d\n", *t->content->u.numeric);
313 else if (t->content->which == Z_ElementData_oid)
315 int *ip = t->content->u.oid;
318 if ((oent = oid_getentbyoid(t->content->u.oid)))
319 printf("OID: %s\n", oent->desc);
323 while (ip && *ip >= 0)
324 printf(" %d", *(ip++));
328 else if (t->content->which == Z_ElementData_noDataRequested)
329 printf("[No data requested]\n");
330 else if (t->content->which == Z_ElementData_elementEmpty)
331 printf("[Element empty]\n");
332 else if (t->content->which == Z_ElementData_elementNotThere)
333 printf("[Element not there]\n");
336 if (t->appliedVariant)
337 display_variant(t->appliedVariant, level+1);
338 if (t->metaData && t->metaData->supportedVariants)
342 printf("%*s---- variant list\n", (level+1)*4, "");
343 for (c = 0; c < t->metaData->num_supportedVariants; c++)
345 printf("%*svariant #%d\n", (level+1)*4, "", c);
346 display_variant(t->metaData->supportedVariants[c], level + 2);
352 void MyClient::recv_genericRecord(Z_GenericRecord *r)
354 display_genericRecord(r, 0);
357 void MyClient::recv_record(Z_DatabaseRecord *record, int offset,
358 const char *databaseName)
360 Z_External *r = (Z_External*) record;
361 oident *ent = oid_getentbyoid(r->direct_reference);
364 * Tell the user what we got.
366 if (r->direct_reference)
368 printf("Record type: ");
370 printf("%s\n", ent->desc);
372 /* Check if this is a known, ASN.1 type tucked away in an octet string */
373 Z_ext_typeent *etype = z_ext_getentbyref(ent->value);
374 if (ent && (r->which == Z_External_octet || r->which == Z_External_single)
375 && (etype = z_ext_getentbyref(ent->value)))
380 * Call the given decoder to process the record.
382 odr_setbuf(odr_decode(), (char*)record->u.octet_aligned->buf,
383 record->u.octet_aligned->len, 0);
384 if (!(*etype->fun)(odr_decode(), (char **)&rr, 0, 0))
386 odr_perror(odr_decode(), "Decoding constructed record.");
387 fprintf(stderr, "[Near %d]\n", odr_offset(odr_decode()));
388 fprintf(stderr, "Packet dump:\n---------\n");
389 odr_dumpBER(stderr, (char*)record->u.octet_aligned->buf,
390 record->u.octet_aligned->len);
391 fprintf(stderr, "---------\n");
393 if (etype->what == Z_External_sutrs)
395 Z_SUTRS *sutrs = (Z_SUTRS *) rr;
396 recv_textRecord ((int) VAL_SUTRS, (const char *) sutrs->buf,
397 (size_t) sutrs->len);
401 if (r->which == Z_External_octet && record->u.octet_aligned->len)
427 marc_display((char*) record->u.octet_aligned->buf,0);
430 recv_textRecord((int) ent->value,
431 (const char *) record->u.octet_aligned->buf,
432 (size_t) record->u.octet_aligned->len);
435 else if (ent && ent->value == VAL_SUTRS && r->which == Z_External_sutrs)
436 recv_textRecord((int) VAL_SUTRS, (const char *) r->u.sutrs->buf,
437 (size_t) r->u.sutrs->len);
438 else if (ent && ent->value == VAL_GRS1 && r->which == Z_External_grs1)
439 recv_genericRecord(r->u.grs1);
442 printf("Unknown record representation.\n");
443 if (!z_External(odr_print(), &r, 0, 0))
445 odr_perror(odr_print(), "Printing external");
446 odr_reset(odr_print());
451 void MyClient::recv_namePlusRecord (Z_NamePlusRecord *zpr, int offset)
453 if (zpr->databaseName)
454 printf("[%s]", zpr->databaseName);
455 if (zpr->which == Z_NamePlusRecord_surrogateDiagnostic)
456 recv_diagrecs(&zpr->u.surrogateDiagnostic, 1);
458 recv_record(zpr->u.databaseRecord, offset, zpr->databaseName);
461 void MyClient::recv_records (Z_Records *records)
464 Z_DiagRec dr, *dr_p = &dr;
469 switch (records->which)
471 case Z_Records_DBOSD:
472 for (i = 0; i < records->u.databaseOrSurDiagnostics->num_records; i++)
473 recv_namePlusRecord(records->u.databaseOrSurDiagnostics->
474 records[i], i + m_setOffset);
475 m_setOffset += records->u.databaseOrSurDiagnostics->num_records;
479 dr.which = Z_DiagRec_defaultFormat;
480 dr.u.defaultFormat = records->u.nonSurrogateDiagnostic;
481 recv_diagrecs (&dr_p, 1);
483 recv_diagrecs (&records->u.nonSurrogateDiagnostic, 1);
486 case Z_Records_multipleNSD:
487 recv_diagrecs (records->u.multipleNonSurDiagnostics->diagRecs,
488 records->u.multipleNonSurDiagnostics->num_diagRecs);
493 void MyClient::recv_searchResponse(Z_SearchResponse *searchResponse)
495 printf ("Got SearchResponse. Status ");
496 if (!*searchResponse->searchStatus)
502 printf ("Hits: %d\n", *searchResponse->resultCount);
503 recv_records (searchResponse->records);
506 void MyClient::recv_presentResponse(Z_PresentResponse *presentResponse)
508 printf ("Got PresentResponse\n");
509 recv_records (presentResponse->records);
515 while (m_socketManager->processEvent() > 0)
517 if (get_lastReceived())
523 #define C_PROMPT "Z>"
525 int MyClient::cmd_connect(char *host)
534 int MyClient::cmd_open(char *host)
545 int MyClient::cmd_init(char *args)
547 if (send_initRequest() >= 0)
554 int MyClient::cmd_quit(char *args)
559 int MyClient::cmd_close(char *args)
565 int MyClient::cmd_find(char *args)
569 if (query.set_rpn(args) <= 0)
571 printf ("Bad RPN query\n");
574 if (send_searchRequest(&query) >= 0)
577 printf ("Not connected\n");
581 int MyClient::cmd_show(char *args)
583 int start = m_setOffset, number = 1;
585 sscanf (args, "%d %d", &start, &number);
587 if (send_presentRequest(start, number) >= 0)
590 printf ("Not connected\n");
594 int MyClient::cmd_cookie(char *args)
596 set_cookie(*args ? args : 0);
600 int MyClient::cmd_format(char *args)
602 set_preferredRecordSyntax(args);
606 int MyClient::cmd_proxy(char *args)
612 #if HAVE_YAZ_URSULA_H
613 int MyClient::cmd_ursula(char *args)
615 Z_APDU *apdu = create_Z_PDU(Z_APDU_extendedServicesRequest);
616 Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
618 req->packageType = odr_getoidbystr(odr_encode(), "1.2.840.10003");
620 Z_External *ext = (Z_External *) odr_malloc(odr_encode(), sizeof(*ext));
621 req->taskSpecificParameters = ext;
622 ext->direct_reference = req->packageType;
624 ext->indirect_reference = 0;
626 ext->which = Z_External_octet;
627 ext->u.single_ASN1_type = (Odr_oct *)
628 odr_malloc (odr_encode(), sizeof(Odr_oct));
630 Z_UrsPDU *pdu = (Z_UrsPDU *) odr_malloc (odr_encode(), sizeof(*pdu));
631 pdu->which = Z_UrsPDU_request;
632 pdu->u.request = (Z_UrsRequest *)
633 odr_malloc (odr_encode(), sizeof(*pdu->u.request));
634 pdu->u.request->libraryNo = odr_strdup(odr_encode(), "000200");
635 pdu->u.request->borrowerTickerNo = 0;
636 pdu->u.request->disposalType = 0;
637 pdu->u.request->lastUseDate = 0;
638 pdu->u.request->num_items = 0;
639 pdu->u.request->items = (Z_UrsRequestItem **) odr_nullval();
640 pdu->u.request->counter = 0;
641 pdu->u.request->priority = 0;
642 pdu->u.request->disposalNote = 0;
643 pdu->u.request->overrule = 0;
645 if (!z_UrsPDU (odr_encode(), &pdu, 0, ""))
647 yaz_log (LOG_LOG, "ursula encoding failed");
651 odr_getbuf (odr_encode(), &ext->u.single_ASN1_type->len, 0);
653 ext->u.single_ASN1_type->buf = (unsigned char*)
654 odr_malloc (odr_encode(), ext->u.single_ASN1_type->len);
655 memcpy (ext->u.single_ASN1_type->buf, buf, ext->u.single_ASN1_type->len);
656 ext->u.single_ASN1_type->size = ext->u.single_ASN1_type->len;
658 if (send_Z_PDU(apdu) >= 0)
664 int MyClient::processCommand(const char *commandLine)
666 char cmdStr[1024], cmdArgs[1024];
671 int (MyClient::*fun)(char *arg);
674 {"open", &MyClient::cmd_open, "<host>[':'<port>][/<database>]"},
675 {"connect", &MyClient::cmd_connect, "<host>[':'<port>][/<database>]"},
676 {"quit", &MyClient::cmd_quit, ""},
677 {"close", &MyClient::cmd_close, ""},
678 {"find", &MyClient::cmd_find, "<query>"},
679 {"show", &MyClient::cmd_show, "[<start> [<number>]]"},
680 {"cookie", &MyClient::cmd_cookie, "<cookie>"},
681 {"init", &MyClient::cmd_init, ""},
682 {"format", &MyClient::cmd_format, "<record-syntax>"},
683 {"proxy", &MyClient::cmd_proxy, "<host>:[':'<port>]"},
684 #if HAVE_YAZ_URSULA_H
685 {"ursula", &MyClient::cmd_ursula, ""},
690 if (sscanf(commandLine, "%s %[^;]", cmdStr, cmdArgs) < 1)
693 for (i = 0; cmd[i].cmd; i++)
694 if (!strncmp(cmd[i].cmd, cmdStr, strlen(cmdStr)))
698 if (cmd[i].cmd) // Invoke command handler
699 res = (this->*cmd[i].fun)(cmdArgs);
700 else // Dump help screen
702 printf("Unknown command: %s.\n", cmdStr);
703 printf("Currently recognized commands:\n");
704 for (i = 0; cmd[i].cmd; i++)
705 printf(" %s %s\n", cmd[i].cmd, cmd[i].ad);
710 const char *MyClient::getCommand()
712 #if HAVE_READLINE_READLINE_H
713 // Read using GNU readline
715 line_in=readline(C_PROMPT);
718 #if HAVE_READLINE_HISTORY_H
720 add_history(line_in);
722 strncpy(m_thisCommand,line_in, 1023);
723 m_thisCommand[1023] = '\0';
726 // Read using fgets(3)
729 if (!fgets(m_thisCommand, 1023, stdin))
732 // Remove trailing whitespace
733 char *cp = m_thisCommand + strlen(m_thisCommand);
734 while (cp != m_thisCommand && strchr("\t \n", cp[-1]))
738 // Remove leading spaces...
739 while (*cp && strchr ("\t \n", *cp))
741 // Save command if non-empty
743 strcpy (m_lastCommand, cp);
744 return m_lastCommand;
747 int MyClient::interactive(Yaz_SocketManager *socketManager)
750 if (!m_interactive_flag)
752 while ((cmd = getCommand()))
754 if (!processCommand(cmd))
760 int MyClient::args(Yaz_SocketManager *socketManager, int argc, char **argv)
765 char *prog = argv[0];
768 while ((ret = options("c:p:v:q", argv, argc, &arg)) != -2)
792 yaz_log_init_level (yaz_log_mask_str(arg));
795 m_interactive_flag = 0;
814 int main(int argc, char **argv)
816 Yaz_SocketManager mySocketManager;
817 Yaz_PDU_Assoc *some = new Yaz_PDU_Assoc(&mySocketManager);
819 MyClient z(some, &mySocketManager);
821 if (z.args(&mySocketManager, argc, argv))
823 if (z.interactive(&mySocketManager))