2 * Copyright (c) 1998-2000, Index Data.
3 * See the file LICENSE for details.
5 * $Log: yaz-client.cpp,v $
6 * Revision 1.14 2000-09-08 10:23:42 adam
7 * Added skeleton of yaz-z-server.
9 * Revision 1.13 2000/09/06 14:23:45 adam
12 * Revision 1.12 2000/09/04 08:59:16 adam
13 * Changed call to logging functions (yaz_ added).
15 * Revision 1.11 2000/07/04 13:48:49 adam
16 * Implemented upper-limit on proxy-to-target sessions.
18 * Revision 1.10 2000/05/30 03:12:27 ian
19 * minor change to stop g++ 2.95.2 complaining about taking the address
20 * of a member function.
22 * Revision 1.9 1999/12/06 13:52:45 adam
23 * Modified for new location of YAZ header files. Experimental threaded
26 * Revision 1.8 1999/11/10 10:02:34 adam
29 * Revision 1.7 1999/04/21 12:09:01 adam
30 * Many improvements. Modified to proxy server to work with "sessions"
33 * Revision 1.6 1999/04/20 10:30:05 adam
34 * Implemented various stuff for client and proxy. Updated calls
35 * to ODR to reflect new name parameter.
37 * Revision 1.5 1999/04/09 11:46:57 adam
38 * Added object Yaz_Z_Assoc. Much more functional client.
40 * Revision 1.4 1999/03/23 14:17:57 adam
41 * More work on timeout handling. Work on yaz-client.
43 * Revision 1.3 1999/02/02 14:01:18 adam
44 * First WIN32 port of YAZ++.
46 * Revision 1.2 1999/01/28 13:08:42 adam
47 * Yaz_PDU_Assoc better encapsulated. Memory leak fix in
48 * yaz-socket-manager.cc.
50 * Revision 1.1.1.1 1999/01/28 09:41:07 adam
51 * First implementation of YAZ++.
56 #include <yaz/options.h>
57 #include <yaz/diagbib1.h>
58 #include <yaz-ir-assoc.h>
59 #include <yaz-pdu-assoc.h>
60 #include <yaz-socket-manager.h>
63 #if HAVE_READLINE_READLINE_H
64 #include <readline/readline.h>
66 #if HAVE_READLINE_HISTORY_H
67 #include <readline/history.h>
71 class YAZ_EXPORT MyClient : public Yaz_IR_Assoc {
73 int m_interactive_flag;
74 char m_thisCommand[1024];
75 char m_lastCommand[1024];
77 Yaz_SocketManager *m_socketManager;
79 MyClient(IYaz_PDU_Observable *the_PDU_Observable,
80 Yaz_SocketManager *the_SocketManager);
81 IYaz_PDU_Observer *clone(IYaz_PDU_Observable *the_PDU_Observable);
82 int args(Yaz_SocketManager *socketManager, int argc, char **argv);
83 int interactive(Yaz_SocketManager *socketManager);
85 void recv_initResponse(Z_InitResponse *initResponse);
86 void recv_searchResponse(Z_SearchResponse *searchResponse);
87 void recv_presentResponse(Z_PresentResponse *presentResponse);
88 void recv_records (Z_Records *records);
89 void recv_diagrecs(Z_DiagRec **pp, int num);
90 void recv_namePlusRecord (Z_NamePlusRecord *zpr, int offset);
91 void recv_record(Z_DatabaseRecord *record, int offset,
92 const char *databaseName);
93 void recv_textRecord(int type, const char *buf, size_t len);
94 void recv_genericRecord(Z_GenericRecord *r);
95 void display_genericRecord(Z_GenericRecord *r, int level);
96 void display_variant(Z_Variant *v, int level);
100 char *get_cookie (Z_OtherInformation **oi);
101 int processCommand(const char *cmd);
102 const char *MyClient::getCommand();
103 int cmd_open(char *host);
104 int cmd_connect(char *host);
105 int cmd_quit(char *args);
106 int cmd_close(char *args);
107 int cmd_find(char *args);
108 int cmd_show(char *args);
109 int cmd_cookie(char *args);
110 int cmd_init(char *args);
111 int cmd_format(char *args);
112 int cmd_proxy(char *args);
116 void MyClient::connectNotify()
118 printf ("Connection accepted by target\n");
119 set_lastReceived(-1);
122 void MyClient::timeoutNotify()
124 printf ("Connection timeout\n");
128 void MyClient::failNotify()
130 printf ("Connection closed by target\n");
131 set_lastReceived(-1);
134 IYaz_PDU_Observer *MyClient::clone(IYaz_PDU_Observable *the_PDU_Observable)
136 return new MyClient(the_PDU_Observable, m_socketManager);
139 MyClient::MyClient(IYaz_PDU_Observable *the_PDU_Observable,
140 Yaz_SocketManager *the_socketManager) :
141 Yaz_IR_Assoc (the_PDU_Observable)
144 m_interactive_flag = 1;
145 m_thisCommand[0] = '\0';
146 m_lastCommand[0] = '\0';
147 m_socketManager = the_socketManager;
150 void usage(char *prog)
152 fprintf (stderr, "%s: [-v log] [-c cookie] [-p proxy] [zurl]\n", prog);
156 char *MyClient::get_cookie(Z_OtherInformation **otherInfo)
159 Z_OtherInformationUnit *oi;
161 ent.proto = PROTO_Z3950;
162 ent.oclass = CLASS_USERINFO;
163 ent.value = (oid_value) VAL_COOKIE;
165 if (oid_ent_to_oid (&ent, oid) &&
166 (oi = update_otherInformation(otherInfo, 0, oid, 1, 1)) &&
167 oi->which == Z_OtherInfo_characterInfo)
168 return oi->information.characterInfo;
172 void MyClient::recv_initResponse(Z_InitResponse *initResponse)
174 printf ("Got InitResponse. Status ");
175 if (*initResponse->result)
179 const char *p = get_cookie (&initResponse->otherInfo);
182 printf ("cookie = %s\n", p);
190 void MyClient::recv_diagrecs(Z_DiagRec **pp, int num)
194 Z_DefaultDiagFormat *r;
196 printf("Diagnostic message(s) from database:\n");
197 for (i = 0; i<num; i++)
199 Z_DiagRec *p = pp[i];
200 if (p->which != Z_DiagRec_defaultFormat)
202 printf("Diagnostic record not in default format.\n");
206 r = p->u.defaultFormat;
207 if (!(ent = oid_getentbyoid(r->diagnosticSetId)) ||
208 ent->oclass != CLASS_DIAGSET || ent->value != VAL_BIB1)
209 printf("Missing or unknown diagset\n");
210 printf(" [%d] %s", *r->condition, diagbib1_str(*r->condition));
214 case Z_DefaultDiagFormat_v2Addinfo:
215 printf (" -- v2 addinfo '%s'\n", r->u.v2Addinfo);
217 case Z_DefaultDiagFormat_v3Addinfo:
218 printf (" -- v3 addinfo '%s'\n", r->u.v3Addinfo);
222 if (r->addinfo && *r->addinfo)
223 printf(" -- '%s'\n", r->addinfo);
230 void MyClient::recv_textRecord(int type, const char *buf, size_t len)
232 fwrite (buf, 1, len, stdout);
233 fputc ('\n', stdout);
236 void MyClient::display_variant(Z_Variant *v, int level)
240 for (i = 0; i < v->num_triples; i++)
242 printf("%*sclass=%d,type=%d", level * 4, "", *v->triples[i]->zclass,
243 *v->triples[i]->type);
244 if (v->triples[i]->which == Z_Triple_internationalString)
245 printf(",value=%s\n", v->triples[i]->value.internationalString);
251 void MyClient::display_genericRecord(Z_GenericRecord *r, int level)
257 for (i = 0; i < r->num_elements; i++)
261 printf("%*s", level * 4, "");
265 printf("%d,", *t->tagType);
268 if (t->tagValue->which == Z_StringOrNumeric_numeric)
269 printf("%d) ", *t->tagValue->u.numeric);
271 printf("%s) ", t->tagValue->u.string);
272 if (t->content->which == Z_ElementData_subtree)
275 display_genericRecord(t->content->u.subtree, level+1);
277 else if (t->content->which == Z_ElementData_string)
278 printf("%s\n", t->content->u.string);
279 else if (t->content->which == Z_ElementData_numeric)
280 printf("%d\n", *t->content->u.numeric);
281 else if (t->content->which == Z_ElementData_oid)
283 int *ip = t->content->u.oid;
286 if ((oent = oid_getentbyoid(t->content->u.oid)))
287 printf("OID: %s\n", oent->desc);
291 while (ip && *ip >= 0)
292 printf(" %d", *(ip++));
296 else if (t->content->which == Z_ElementData_noDataRequested)
297 printf("[No data requested]\n");
298 else if (t->content->which == Z_ElementData_elementEmpty)
299 printf("[Element empty]\n");
300 else if (t->content->which == Z_ElementData_elementNotThere)
301 printf("[Element not there]\n");
304 if (t->appliedVariant)
305 display_variant(t->appliedVariant, level+1);
306 if (t->metaData && t->metaData->supportedVariants)
310 printf("%*s---- variant list\n", (level+1)*4, "");
311 for (c = 0; c < t->metaData->num_supportedVariants; c++)
313 printf("%*svariant #%d\n", (level+1)*4, "", c);
314 display_variant(t->metaData->supportedVariants[c], level + 2);
320 void MyClient::recv_genericRecord(Z_GenericRecord *r)
322 display_genericRecord(r, 0);
325 void MyClient::recv_record(Z_DatabaseRecord *record, int offset,
326 const char *databaseName)
328 Z_External *r = (Z_External*) record;
329 oident *ent = oid_getentbyoid(r->direct_reference);
332 * Tell the user what we got.
334 if (r->direct_reference)
336 printf("Record type: ");
338 printf("%s\n", ent->desc);
340 /* Check if this is a known, ASN.1 type tucked away in an octet string */
341 Z_ext_typeent *etype = z_ext_getentbyref(ent->value);
342 if (ent && (r->which == Z_External_octet || r->which == Z_External_single)
343 && (etype = z_ext_getentbyref(ent->value)))
348 * Call the given decoder to process the record.
350 odr_setbuf(odr_decode(), (char*)record->u.octet_aligned->buf,
351 record->u.octet_aligned->len, 0);
352 if (!(*etype->fun)(odr_decode(), (char **)&rr, 0, 0))
354 odr_perror(odr_decode(), "Decoding constructed record.");
355 fprintf(stderr, "[Near %d]\n", odr_offset(odr_decode()));
356 fprintf(stderr, "Packet dump:\n---------\n");
357 odr_dumpBER(stderr, (char*)record->u.octet_aligned->buf,
358 record->u.octet_aligned->len);
359 fprintf(stderr, "---------\n");
361 if (etype->what == Z_External_sutrs)
363 Z_SUTRS *sutrs = (Z_SUTRS *) rr;
364 recv_textRecord ((int) VAL_SUTRS, (const char *) sutrs->buf,
365 (size_t) sutrs->len);
369 if (r->which == Z_External_octet && record->u.octet_aligned->len)
371 recv_textRecord((int) ent->value,
372 (const char *) record->u.octet_aligned->buf,
373 (size_t) record->u.octet_aligned->len);
375 else if (ent && ent->value == VAL_SUTRS && r->which == Z_External_sutrs)
376 recv_textRecord((int) VAL_SUTRS, (const char *) r->u.sutrs->buf,
377 (size_t) r->u.sutrs->len);
378 else if (ent && ent->value == VAL_GRS1 && r->which == Z_External_grs1)
379 recv_genericRecord(r->u.grs1);
382 printf("Unknown record representation.\n");
383 if (!z_External(odr_print(), &r, 0, 0))
385 odr_perror(odr_print(), "Printing external");
386 odr_reset(odr_print());
391 void MyClient::recv_namePlusRecord (Z_NamePlusRecord *zpr, int offset)
393 if (zpr->databaseName)
394 printf("[%s]", zpr->databaseName);
395 if (zpr->which == Z_NamePlusRecord_surrogateDiagnostic)
396 recv_diagrecs(&zpr->u.surrogateDiagnostic, 1);
398 recv_record(zpr->u.databaseRecord, offset, zpr->databaseName);
401 void MyClient::recv_records (Z_Records *records)
404 Z_DiagRec dr, *dr_p = &dr;
409 switch (records->which)
411 case Z_Records_DBOSD:
412 for (i = 0; i < records->u.databaseOrSurDiagnostics->num_records; i++)
413 recv_namePlusRecord(records->u.databaseOrSurDiagnostics->
414 records[i], i + m_setOffset);
415 m_setOffset += records->u.databaseOrSurDiagnostics->num_records;
419 dr.which = Z_DiagRec_defaultFormat;
420 dr.u.defaultFormat = records->u.nonSurrogateDiagnostic;
421 recv_diagrecs (&dr_p, 1);
423 recv_diagrecs (&records->u.nonSurrogateDiagnostic, 1);
426 case Z_Records_multipleNSD:
427 recv_diagrecs (records->u.multipleNonSurDiagnostics->diagRecs,
428 records->u.multipleNonSurDiagnostics->num_diagRecs);
433 void MyClient::recv_searchResponse(Z_SearchResponse *searchResponse)
435 printf ("Got SearchResponse. Status ");
436 if (!*searchResponse->searchStatus)
442 printf ("Hits: %d\n", *searchResponse->resultCount);
443 recv_records (searchResponse->records);
446 void MyClient::recv_presentResponse(Z_PresentResponse *presentResponse)
448 printf ("Got PresentResponse\n");
449 recv_records (presentResponse->records);
455 while (m_socketManager->processEvent() > 0)
457 if (get_lastReceived())
463 #define C_PROMPT "Z>"
465 int MyClient::cmd_connect(char *host)
474 int MyClient::cmd_open(char *host)
485 int MyClient::cmd_init(char *args)
487 if (send_initRequest() >= 0)
494 int MyClient::cmd_quit(char *args)
499 int MyClient::cmd_close(char *args)
505 int MyClient::cmd_find(char *args)
509 if (query.set_rpn(args) <= 0)
511 printf ("Bad RPN query\n");
514 if (send_searchRequest(&query) >= 0)
517 printf ("Not connected\n");
521 int MyClient::cmd_show(char *args)
523 int start = m_setOffset, number = 1;
525 sscanf (args, "%d %d", &start, &number);
527 if (send_presentRequest(start, number) >= 0)
530 printf ("Not connected\n");
534 int MyClient::cmd_cookie(char *args)
536 set_cookie(*args ? args : 0);
540 int MyClient::cmd_format(char *args)
542 set_preferredRecordSyntax(args);
546 int MyClient::cmd_proxy(char *args)
552 int MyClient::processCommand(const char *commandLine)
554 char cmdStr[1024], cmdArgs[1024];
559 int (MyClient::*fun)(char *arg);
562 {"open", &MyClient::cmd_open, "<host>[':'<port>][/<database>]"},
563 {"connect", &MyClient::cmd_connect, "<host>[':'<port>][/<database>]"},
564 {"quit", &MyClient::cmd_quit, ""},
565 {"close", &MyClient::cmd_close, ""},
566 {"find", &MyClient::cmd_find, "<query>"},
567 {"show", &MyClient::cmd_show, "[<start> [<number>]]"},
568 {"cookie", &MyClient::cmd_cookie, "<cookie>"},
569 {"init", &MyClient::cmd_init, ""},
570 {"format", &MyClient::cmd_format, "<record-syntax>"},
571 {"proxy", &MyClient::cmd_proxy, "<host>:[':'<port>]"},
575 if (sscanf(commandLine, "%s %[^;]", cmdStr, cmdArgs) < 1)
578 for (i = 0; cmd[i].cmd; i++)
579 if (!strncmp(cmd[i].cmd, cmdStr, strlen(cmdStr)))
583 if (cmd[i].cmd) // Invoke command handler
584 res = (this->*cmd[i].fun)(cmdArgs);
585 else // Dump help screen
587 printf("Unknown command: %s.\n", cmdStr);
588 printf("Currently recognized commands:\n");
589 for (i = 0; cmd[i].cmd; i++)
590 printf(" %s %s\n", cmd[i].cmd, cmd[i].ad);
595 const char *MyClient::getCommand()
597 #if HAVE_READLINE_READLINE_H
598 // Read using GNU readline
600 line_in=readline(C_PROMPT);
603 #if HAVE_READLINE_HISTORY_H
605 add_history(line_in);
607 strncpy(m_thisCommand,line_in, 1023);
608 m_thisCommand[1023] = '\0';
611 // Read using fgets(3)
614 if (!fgets(m_thisCommand, 1023, stdin))
617 // Remove trailing whitespace
618 char *cp = m_thisCommand + strlen(m_thisCommand);
619 while (cp != m_thisCommand && strchr("\t \n", cp[-1]))
623 // Remove leading spaces...
624 while (*cp && strchr ("\t \n", *cp))
626 // Save command if non-empty
628 strcpy (m_lastCommand, cp);
629 return m_lastCommand;
632 int MyClient::interactive(Yaz_SocketManager *socketManager)
635 if (!m_interactive_flag)
637 while ((cmd = getCommand()))
639 if (!processCommand(cmd))
645 int MyClient::args(Yaz_SocketManager *socketManager, int argc, char **argv)
650 char *prog = argv[0];
653 while ((ret = options("c:p:v:q", argv, argc, &arg)) != -2)
677 yaz_log_init_level (yaz_log_mask_str(arg));
680 m_interactive_flag = 0;
699 int main(int argc, char **argv)
701 Yaz_SocketManager mySocketManager;
702 Yaz_PDU_Assoc *some = new Yaz_PDU_Assoc(&mySocketManager);
704 MyClient z(some, &mySocketManager);
706 if (z.args(&mySocketManager, argc, argv))
708 if (z.interactive(&mySocketManager))