2 * Copyright (c) 1998-2000, Index Data.
3 * See the file LICENSE for details.
4 * Sebastian Hammer, Adam Dickmeiss
6 * $Log: yaz-client.cpp,v $
7 * Revision 1.12 2000-09-04 08:59:16 adam
8 * Changed call to logging functions (yaz_ added).
10 * Revision 1.11 2000/07/04 13:48:49 adam
11 * Implemented upper-limit on proxy-to-target sessions.
13 * Revision 1.10 2000/05/30 03:12:27 ian
14 * minor change to stop g++ 2.95.2 complaining about taking the address
15 * of a member function.
17 * Revision 1.9 1999/12/06 13:52:45 adam
18 * Modified for new location of YAZ header files. Experimental threaded
21 * Revision 1.8 1999/11/10 10:02:34 adam
24 * Revision 1.7 1999/04/21 12:09:01 adam
25 * Many improvements. Modified to proxy server to work with "sessions"
28 * Revision 1.6 1999/04/20 10:30:05 adam
29 * Implemented various stuff for client and proxy. Updated calls
30 * to ODR to reflect new name parameter.
32 * Revision 1.5 1999/04/09 11:46:57 adam
33 * Added object Yaz_Z_Assoc. Much more functional client.
35 * Revision 1.4 1999/03/23 14:17:57 adam
36 * More work on timeout handling. Work on yaz-client.
38 * Revision 1.3 1999/02/02 14:01:18 adam
39 * First WIN32 port of YAZ++.
41 * Revision 1.2 1999/01/28 13:08:42 adam
42 * Yaz_PDU_Assoc better encapsulated. Memory leak fix in
43 * yaz-socket-manager.cc.
45 * Revision 1.1.1.1 1999/01/28 09:41:07 adam
46 * First implementation of YAZ++.
51 #include <yaz/options.h>
52 #include <yaz/diagbib1.h>
53 #include <yaz-ir-assoc.h>
54 #include <yaz-pdu-assoc.h>
55 #include <yaz-socket-manager.h>
58 #if HAVE_READLINE_READLINE_H
59 #include <readline/readline.h>
61 #if HAVE_READLINE_HISTORY_H
62 #include <readline/history.h>
66 class YAZ_EXPORT MyClient : public Yaz_IR_Assoc {
68 int m_interactive_flag;
69 char m_thisCommand[1024];
70 char m_lastCommand[1024];
72 Yaz_SocketManager *m_socketManager;
74 MyClient(IYaz_PDU_Observable *the_PDU_Observable,
75 Yaz_SocketManager *the_SocketManager);
76 IYaz_PDU_Observer *clone(IYaz_PDU_Observable *the_PDU_Observable);
77 int args(Yaz_SocketManager *socketManager, int argc, char **argv);
78 int interactive(Yaz_SocketManager *socketManager);
80 void recv_initResponse(Z_InitResponse *initResponse);
81 void recv_searchResponse(Z_SearchResponse *searchResponse);
82 void recv_presentResponse(Z_PresentResponse *presentResponse);
83 void recv_records (Z_Records *records);
84 void recv_diagrecs(Z_DiagRec **pp, int num);
85 void recv_namePlusRecord (Z_NamePlusRecord *zpr, int offset);
86 void recv_record(Z_DatabaseRecord *record, int offset,
87 const char *databaseName);
88 void recv_textRecord(int type, const char *buf, size_t len);
89 void recv_genericRecord(Z_GenericRecord *r);
90 void display_genericRecord(Z_GenericRecord *r, int level);
91 void display_variant(Z_Variant *v, int level);
95 char *get_cookie (Z_OtherInformation **oi);
96 int processCommand(const char *cmd);
97 const char *MyClient::getCommand();
98 int cmd_open(char *host);
99 int cmd_connect(char *host);
100 int cmd_quit(char *args);
101 int cmd_close(char *args);
102 int cmd_find(char *args);
103 int cmd_show(char *args);
104 int cmd_cookie(char *args);
105 int cmd_init(char *args);
106 int cmd_format(char *args);
107 int cmd_proxy(char *args);
111 void MyClient::connectNotify()
113 printf ("Connection accepted by target\n");
114 set_lastReceived(-1);
117 void MyClient::timeoutNotify()
119 printf ("Connection timeout\n");
123 void MyClient::failNotify()
125 printf ("Connection closed by target\n");
126 set_lastReceived(-1);
129 IYaz_PDU_Observer *MyClient::clone(IYaz_PDU_Observable *the_PDU_Observable)
131 return new MyClient(the_PDU_Observable, m_socketManager);
134 MyClient::MyClient(IYaz_PDU_Observable *the_PDU_Observable,
135 Yaz_SocketManager *the_socketManager) :
136 Yaz_IR_Assoc (the_PDU_Observable)
139 m_interactive_flag = 1;
140 m_thisCommand[0] = '\0';
141 m_lastCommand[0] = '\0';
142 m_socketManager = the_socketManager;
145 void usage(char *prog)
147 fprintf (stderr, "%s: [-v log] [-c cookie] [-p proxy] [zurl]\n", prog);
151 char *MyClient::get_cookie(Z_OtherInformation **otherInfo)
154 Z_OtherInformationUnit *oi;
156 ent.proto = PROTO_Z3950;
157 ent.oclass = CLASS_USERINFO;
158 ent.value = (oid_value) VAL_COOKIE;
160 if (oid_ent_to_oid (&ent, oid) &&
161 (oi = update_otherInformation(otherInfo, 0, oid, 1, 1)) &&
162 oi->which == Z_OtherInfo_characterInfo)
163 return oi->information.characterInfo;
167 void MyClient::recv_initResponse(Z_InitResponse *initResponse)
169 printf ("Got InitResponse. Status ");
170 if (*initResponse->result)
174 const char *p = get_cookie (&initResponse->otherInfo);
177 printf ("cookie = %s\n", p);
185 void MyClient::recv_diagrecs(Z_DiagRec **pp, int num)
189 Z_DefaultDiagFormat *r;
191 printf("Diagnostic message(s) from database:\n");
192 for (i = 0; i<num; i++)
194 Z_DiagRec *p = pp[i];
195 if (p->which != Z_DiagRec_defaultFormat)
197 printf("Diagnostic record not in default format.\n");
201 r = p->u.defaultFormat;
202 if (!(ent = oid_getentbyoid(r->diagnosticSetId)) ||
203 ent->oclass != CLASS_DIAGSET || ent->value != VAL_BIB1)
204 printf("Missing or unknown diagset\n");
205 printf(" [%d] %s", *r->condition, diagbib1_str(*r->condition));
209 case Z_DefaultDiagFormat_v2Addinfo:
210 printf (" -- v2 addinfo '%s'\n", r->u.v2Addinfo);
212 case Z_DefaultDiagFormat_v3Addinfo:
213 printf (" -- v3 addinfo '%s'\n", r->u.v3Addinfo);
217 if (r->addinfo && *r->addinfo)
218 printf(" -- '%s'\n", r->addinfo);
225 void MyClient::recv_textRecord(int type, const char *buf, size_t len)
227 fwrite (buf, 1, len, stdout);
228 fputc ('\n', stdout);
231 void MyClient::display_variant(Z_Variant *v, int level)
235 for (i = 0; i < v->num_triples; i++)
237 printf("%*sclass=%d,type=%d", level * 4, "", *v->triples[i]->zclass,
238 *v->triples[i]->type);
239 if (v->triples[i]->which == Z_Triple_internationalString)
240 printf(",value=%s\n", v->triples[i]->value.internationalString);
246 void MyClient::display_genericRecord(Z_GenericRecord *r, int level)
252 for (i = 0; i < r->num_elements; i++)
256 printf("%*s", level * 4, "");
260 printf("%d,", *t->tagType);
263 if (t->tagValue->which == Z_StringOrNumeric_numeric)
264 printf("%d) ", *t->tagValue->u.numeric);
266 printf("%s) ", t->tagValue->u.string);
267 if (t->content->which == Z_ElementData_subtree)
270 display_genericRecord(t->content->u.subtree, level+1);
272 else if (t->content->which == Z_ElementData_string)
273 printf("%s\n", t->content->u.string);
274 else if (t->content->which == Z_ElementData_numeric)
275 printf("%d\n", *t->content->u.numeric);
276 else if (t->content->which == Z_ElementData_oid)
278 int *ip = t->content->u.oid;
281 if ((oent = oid_getentbyoid(t->content->u.oid)))
282 printf("OID: %s\n", oent->desc);
286 while (ip && *ip >= 0)
287 printf(" %d", *(ip++));
291 else if (t->content->which == Z_ElementData_noDataRequested)
292 printf("[No data requested]\n");
293 else if (t->content->which == Z_ElementData_elementEmpty)
294 printf("[Element empty]\n");
295 else if (t->content->which == Z_ElementData_elementNotThere)
296 printf("[Element not there]\n");
299 if (t->appliedVariant)
300 display_variant(t->appliedVariant, level+1);
301 if (t->metaData && t->metaData->supportedVariants)
305 printf("%*s---- variant list\n", (level+1)*4, "");
306 for (c = 0; c < t->metaData->num_supportedVariants; c++)
308 printf("%*svariant #%d\n", (level+1)*4, "", c);
309 display_variant(t->metaData->supportedVariants[c], level + 2);
315 void MyClient::recv_genericRecord(Z_GenericRecord *r)
317 display_genericRecord(r, 0);
320 void MyClient::recv_record(Z_DatabaseRecord *record, int offset,
321 const char *databaseName)
323 Z_External *r = (Z_External*) record;
324 oident *ent = oid_getentbyoid(r->direct_reference);
327 * Tell the user what we got.
329 if (r->direct_reference)
331 printf("Record type: ");
333 printf("%s\n", ent->desc);
335 /* Check if this is a known, ASN.1 type tucked away in an octet string */
336 Z_ext_typeent *etype = z_ext_getentbyref(ent->value);
337 if (ent && (r->which == Z_External_octet || r->which == Z_External_single)
338 && (etype = z_ext_getentbyref(ent->value)))
343 * Call the given decoder to process the record.
345 odr_setbuf(odr_decode(), (char*)record->u.octet_aligned->buf,
346 record->u.octet_aligned->len, 0);
347 if (!(*etype->fun)(odr_decode(), (char **)&rr, 0, 0))
349 odr_perror(odr_decode(), "Decoding constructed record.");
350 fprintf(stderr, "[Near %d]\n", odr_offset(odr_decode()));
351 fprintf(stderr, "Packet dump:\n---------\n");
352 odr_dumpBER(stderr, (char*)record->u.octet_aligned->buf,
353 record->u.octet_aligned->len);
354 fprintf(stderr, "---------\n");
356 if (etype->what == Z_External_sutrs)
358 Z_SUTRS *sutrs = (Z_SUTRS *) rr;
359 recv_textRecord ((int) VAL_SUTRS, (const char *) sutrs->buf,
360 (size_t) sutrs->len);
364 if (r->which == Z_External_octet && record->u.octet_aligned->len)
366 recv_textRecord((int) ent->value,
367 (const char *) record->u.octet_aligned->buf,
368 (size_t) record->u.octet_aligned->len);
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);
377 printf("Unknown record representation.\n");
378 if (!z_External(odr_print(), &r, 0, 0))
380 odr_perror(odr_print(), "Printing external");
381 odr_reset(odr_print());
386 void MyClient::recv_namePlusRecord (Z_NamePlusRecord *zpr, int offset)
388 if (zpr->databaseName)
389 printf("[%s]", zpr->databaseName);
390 if (zpr->which == Z_NamePlusRecord_surrogateDiagnostic)
391 recv_diagrecs(&zpr->u.surrogateDiagnostic, 1);
393 recv_record(zpr->u.databaseRecord, offset, zpr->databaseName);
396 void MyClient::recv_records (Z_Records *records)
399 Z_DiagRec dr, *dr_p = &dr;
404 switch (records->which)
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;
414 dr.which = Z_DiagRec_defaultFormat;
415 dr.u.defaultFormat = records->u.nonSurrogateDiagnostic;
416 recv_diagrecs (&dr_p, 1);
418 recv_diagrecs (&records->u.nonSurrogateDiagnostic, 1);
421 case Z_Records_multipleNSD:
422 recv_diagrecs (records->u.multipleNonSurDiagnostics->diagRecs,
423 records->u.multipleNonSurDiagnostics->num_diagRecs);
428 void MyClient::recv_searchResponse(Z_SearchResponse *searchResponse)
430 printf ("Got SearchResponse. Status ");
431 if (!*searchResponse->searchStatus)
437 printf ("Hits: %d\n", *searchResponse->resultCount);
438 recv_records (searchResponse->records);
441 void MyClient::recv_presentResponse(Z_PresentResponse *presentResponse)
443 printf ("Got PresentResponse\n");
444 recv_records (presentResponse->records);
450 while (m_socketManager->processEvent() > 0)
452 if (get_lastReceived())
458 #define C_PROMPT "Z>"
460 int MyClient::cmd_connect(char *host)
469 int MyClient::cmd_open(char *host)
480 int MyClient::cmd_init(char *args)
482 if (send_initRequest() >= 0)
489 int MyClient::cmd_quit(char *args)
494 int MyClient::cmd_close(char *args)
500 int MyClient::cmd_find(char *args)
504 if (query.set_rpn(args) <= 0)
506 printf ("Bad RPN query\n");
509 if (send_searchRequest(&query) >= 0)
512 printf ("Not connected\n");
516 int MyClient::cmd_show(char *args)
518 int start = m_setOffset, number = 1;
520 sscanf (args, "%d %d", &start, &number);
522 if (send_presentRequest(start, number) >= 0)
525 printf ("Not connected\n");
529 int MyClient::cmd_cookie(char *args)
531 set_cookie(*args ? args : 0);
535 int MyClient::cmd_format(char *args)
537 set_preferredRecordSyntax(args);
541 int MyClient::cmd_proxy(char *args)
547 int MyClient::processCommand(const char *commandLine)
549 char cmdStr[1024], cmdArgs[1024];
554 int (MyClient::*fun)(char *arg);
557 {"open", &MyClient::cmd_open, "<host>[':'<port>][/<database>]"},
558 {"connect", &MyClient::cmd_connect, "<host>[':'<port>][/<database>]"},
559 {"quit", &MyClient::cmd_quit, ""},
560 {"close", &MyClient::cmd_close, ""},
561 {"find", &MyClient::cmd_find, "<query>"},
562 {"show", &MyClient::cmd_show, "[<start> [<number>]]"},
563 {"cookie", &MyClient::cmd_cookie, "<cookie>"},
564 {"init", &MyClient::cmd_init, ""},
565 {"format", &MyClient::cmd_format, "<record-syntax>"},
566 {"proxy", &MyClient::cmd_proxy, "<host>:[':'<port>]"},
570 if (sscanf(commandLine, "%s %[^;]", cmdStr, cmdArgs) < 1)
573 for (i = 0; cmd[i].cmd; i++)
574 if (!strncmp(cmd[i].cmd, cmdStr, strlen(cmdStr)))
578 if (cmd[i].cmd) // Invoke command handler
579 res = (this->*cmd[i].fun)(cmdArgs);
580 else // Dump help screen
582 printf("Unknown command: %s.\n", cmdStr);
583 printf("Currently recognized commands:\n");
584 for (i = 0; cmd[i].cmd; i++)
585 printf(" %s %s\n", cmd[i].cmd, cmd[i].ad);
590 const char *MyClient::getCommand()
592 #if HAVE_READLINE_READLINE_H
593 // Read using GNU readline
595 line_in=readline(C_PROMPT);
598 #if HAVE_READLINE_HISTORY_H
600 add_history(line_in);
602 strncpy(m_thisCommand,line_in, 1023);
603 m_thisCommand[1023] = '\0';
606 // Read using fgets(3)
609 if (!fgets(m_thisCommand, 1023, stdin))
612 // Remove trailing whitespace
613 char *cp = m_thisCommand + strlen(m_thisCommand);
614 while (cp != m_thisCommand && strchr("\t \n", cp[-1]))
618 // Remove leading spaces...
619 while (*cp && strchr ("\t \n", *cp))
621 // Save command if non-empty
623 strcpy (m_lastCommand, cp);
624 return m_lastCommand;
627 int MyClient::interactive(Yaz_SocketManager *socketManager)
630 if (!m_interactive_flag)
632 while ((cmd = getCommand()))
634 if (!processCommand(cmd))
640 int MyClient::args(Yaz_SocketManager *socketManager, int argc, char **argv)
645 char *prog = argv[0];
648 while ((ret = options("c:p:v:q", argv, argc, &arg)) != -2)
672 yaz_log_init_level (yaz_log_mask_str(arg));
675 m_interactive_flag = 0;
694 int main(int argc, char **argv)
696 Yaz_SocketManager mySocketManager;
697 Yaz_PDU_Assoc *some = new Yaz_PDU_Assoc(&mySocketManager);
699 MyClient z(some, &mySocketManager);
701 if (z.args(&mySocketManager, argc, argv))
703 if (z.interactive(&mySocketManager))