2 * Copyright (C) 1995-2007, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: ztest.c,v 1.88 2007-04-16 21:53:09 adam Exp $
9 * Demonstration of simple server
20 #include <yaz/backend.h>
23 static int log_level=0;
24 static int log_level_set=0;
26 Z_GenericRecord *dummy_grs_record (int num, ODR o);
27 char *dummy_marc_record (int num, ODR odr);
28 char *dummy_xml_record (int num, ODR odr);
30 int ztest_search(void *handle, bend_search_rr *rr);
31 int ztest_sort(void *handle, bend_sort_rr *rr);
32 int ztest_present(void *handle, bend_present_rr *rr);
33 int ztest_esrequest(void *handle, bend_esrequest_rr *rr);
34 int ztest_delete(void *handle, bend_delete_rr *rr);
36 int ztest_search(void *handle, bend_search_rr *rr)
38 if (rr->num_bases != 1)
44 /* if database is stop, stop this process.. For debugging only. */
45 if (!yaz_matchstr (rr->basenames[0], "stop"))
47 nmem_print_list_l(YLOG_LOG);
51 /* Throw Database unavailable if other than Default or Slow */
52 if (!yaz_matchstr (rr->basenames[0], "Default"))
53 ; /* Default is OK in our test */
54 else if(!yaz_matchstr (rr->basenames[0], "Slow"))
57 /* wait up to 3 seconds and check if connection is still alive */
61 if (!bend_assoc_is_alive(rr->association))
63 yaz_log(YLOG_LOG, "search aborted");
69 rr->estimated_hit_count = 1;
74 rr->errstring = rr->basenames[0];
77 rr->hits = rand() % 24;
82 /* this huge function handles extended services */
83 int ztest_esrequest (void *handle, bend_esrequest_rr *rr)
85 /* user-defined handle - created in bend_init */
86 int *counter = (int*) handle;
88 yaz_log(log_level, "ESRequest no %d", *counter);
92 if (rr->esr->packageName)
93 yaz_log(log_level, "packagename: %s", rr->esr->packageName);
94 yaz_log(log_level, "Waitaction: %d", *rr->esr->waitAction);
97 yaz_log(log_level, "function: %d", *rr->esr->function);
99 if (!rr->esr->taskSpecificParameters)
101 yaz_log (log_level, "No task specific parameters");
103 else if (rr->esr->taskSpecificParameters->which == Z_External_itemOrder)
105 Z_ItemOrder *it = rr->esr->taskSpecificParameters->u.itemOrder;
106 yaz_log (log_level, "Received ItemOrder");
107 if (it->which == Z_IOItemOrder_esRequest)
109 Z_IORequest *ir = it->u.esRequest;
110 Z_IOOriginPartToKeep *k = ir->toKeep;
111 Z_IOOriginPartNotToKeep *n = ir->notToKeep;
115 if (k->contact->name)
116 yaz_log(log_level, "contact name %s", k->contact->name);
117 if (k->contact->phone)
118 yaz_log(log_level, "contact phone %s", k->contact->phone);
119 if (k->contact->email)
120 yaz_log(log_level, "contact email %s", k->contact->email);
124 yaz_log(log_level, "Billing info (not shown)");
127 if (n->resultSetItem)
129 yaz_log(log_level, "resultsetItem");
130 yaz_log(log_level, "setId: %s", n->resultSetItem->resultSetId);
131 yaz_log(log_level, "item: %d", *n->resultSetItem->item);
135 Z_External *r = (Z_External*) n->itemRequest;
136 ILL_ItemRequest *item_req = 0;
137 ILL_APDU *ill_apdu = 0;
138 if (r->direct_reference)
140 char oid_name_str[OID_STR_MAX];
142 const char *oid_name =
143 yaz_oid_to_string_buf(r->direct_reference,
144 &oclass, oid_name_str);
146 yaz_log(log_level, "OID %s", oid_name);
147 if (!oid_oidcmp(r->direct_reference, yaz_oid_recsyn_xml))
149 yaz_log (log_level, "ILL XML request");
150 if (r->which == Z_External_octet)
151 yaz_log (log_level, "%.*s", r->u.octet_aligned->len,
152 r->u.octet_aligned->buf);
154 if (!oid_oidcmp(r->direct_reference,
155 yaz_oid_general_isoill_1))
157 yaz_log (log_level, "Decode ItemRequest begin");
158 if (r->which == ODR_EXTERNAL_single)
160 odr_setbuf(rr->decode,
161 (char *) r->u.single_ASN1_type->buf,
162 r->u.single_ASN1_type->len, 0);
164 if (!ill_ItemRequest (rr->decode, &item_req, 0, 0))
167 "Couldn't decode ItemRequest %s near %ld",
168 odr_errmsg(odr_geterror(rr->decode)),
169 (long) odr_offset(rr->decode));
172 yaz_log(log_level, "Decode ItemRequest OK");
175 ill_ItemRequest (rr->print, &item_req, 0,
177 odr_reset (rr->print);
180 if (!item_req && r->which == ODR_EXTERNAL_single)
182 yaz_log (log_level, "Decode ILL APDU begin");
183 odr_setbuf(rr->decode,
184 (char*) r->u.single_ASN1_type->buf,
185 r->u.single_ASN1_type->len, 0);
187 if (!ill_APDU (rr->decode, &ill_apdu, 0, 0))
190 "Couldn't decode ILL APDU %s near %ld",
191 odr_errmsg(odr_geterror(rr->decode)),
192 (long) odr_offset(rr->decode));
193 yaz_log(log_level, "PDU dump:");
194 odr_dumpBER(yaz_log_file(),
195 (char *) r->u.single_ASN1_type->buf,
196 r->u.single_ASN1_type->len);
199 yaz_log(log_level, "Decode ILL APDU OK");
202 ill_APDU (rr->print, &ill_apdu, 0,
204 odr_reset (rr->print);
211 yaz_log (log_level, "ILL protocol version = %d",
212 *item_req->protocol_version_num);
218 Z_External *ext = (Z_External *)
219 odr_malloc (rr->stream, sizeof(*ext));
220 Z_IUOriginPartToKeep *keep = (Z_IUOriginPartToKeep *)
221 odr_malloc (rr->stream, sizeof(*keep));
222 Z_IOTargetPart *targetPart = (Z_IOTargetPart *)
223 odr_malloc (rr->stream, sizeof(*targetPart));
225 rr->taskPackage = (Z_TaskPackage *)
226 odr_malloc (rr->stream, sizeof(*rr->taskPackage));
227 rr->taskPackage->packageType =
228 odr_oiddup (rr->stream, rr->esr->packageType);
229 rr->taskPackage->packageName = 0;
230 rr->taskPackage->userId = 0;
231 rr->taskPackage->retentionTime = 0;
232 rr->taskPackage->permissions = 0;
233 rr->taskPackage->description = 0;
234 rr->taskPackage->targetReference = (Odr_oct *)
235 odr_malloc (rr->stream, sizeof(Odr_oct));
236 rr->taskPackage->targetReference->buf =
237 (unsigned char *) odr_strdup (rr->stream, "911");
238 rr->taskPackage->targetReference->len =
239 rr->taskPackage->targetReference->size =
240 strlen((char *) (rr->taskPackage->targetReference->buf));
241 rr->taskPackage->creationDateTime = 0;
242 rr->taskPackage->taskStatus = odr_intdup(rr->stream, 0);
243 rr->taskPackage->packageDiagnostics = 0;
244 rr->taskPackage->taskSpecificParameters = ext;
246 ext->direct_reference =
247 odr_oiddup (rr->stream, rr->esr->packageType);
248 ext->indirect_reference = 0;
250 ext->which = Z_External_itemOrder;
251 ext->u.itemOrder = (Z_ItemOrder *)
252 odr_malloc (rr->stream, sizeof(*ext->u.update));
253 ext->u.itemOrder->which = Z_IOItemOrder_taskPackage;
254 ext->u.itemOrder->u.taskPackage = (Z_IOTaskPackage *)
255 odr_malloc (rr->stream, sizeof(Z_IOTaskPackage));
256 ext->u.itemOrder->u.taskPackage->originPart = k;
257 ext->u.itemOrder->u.taskPackage->targetPart = targetPart;
259 targetPart->itemRequest = 0;
260 targetPart->statusOrErrorReport = 0;
261 targetPart->auxiliaryStatus = 0;
265 else if (rr->esr->taskSpecificParameters->which == Z_External_update)
267 Z_IUUpdate *up = rr->esr->taskSpecificParameters->u.update;
268 yaz_log (log_level, "Received DB Update");
269 if (up->which == Z_IUUpdate_esRequest)
271 Z_IUUpdateEsRequest *esRequest = up->u.esRequest;
272 Z_IUOriginPartToKeep *toKeep = esRequest->toKeep;
273 Z_IUSuppliedRecords *notToKeep = esRequest->notToKeep;
275 yaz_log (log_level, "action");
278 switch (*toKeep->action)
280 case Z_IUOriginPartToKeep_recordInsert:
281 yaz_log (log_level, " recordInsert");
283 case Z_IUOriginPartToKeep_recordReplace:
284 yaz_log (log_level, " recordReplace");
286 case Z_IUOriginPartToKeep_recordDelete:
287 yaz_log (log_level, " recordDelete");
289 case Z_IUOriginPartToKeep_elementUpdate:
290 yaz_log (log_level, " elementUpdate");
292 case Z_IUOriginPartToKeep_specialUpdate:
293 yaz_log (log_level, " specialUpdate");
296 yaz_log (log_level, " unknown (%d)", *toKeep->action);
299 if (toKeep->databaseName)
301 yaz_log (log_level, "database: %s", toKeep->databaseName);
302 if (!strcmp(toKeep->databaseName, "fault"))
305 rr->errstring = toKeep->databaseName;
307 if (!strcmp(toKeep->databaseName, "accept"))
312 Z_External *ext = (Z_External *)
313 odr_malloc (rr->stream, sizeof(*ext));
314 Z_IUOriginPartToKeep *keep = (Z_IUOriginPartToKeep *)
315 odr_malloc (rr->stream, sizeof(*keep));
316 Z_IUTargetPart *targetPart = (Z_IUTargetPart *)
317 odr_malloc (rr->stream, sizeof(*targetPart));
319 rr->taskPackage = (Z_TaskPackage *)
320 odr_malloc (rr->stream, sizeof(*rr->taskPackage));
321 rr->taskPackage->packageType =
322 odr_oiddup (rr->stream, rr->esr->packageType);
323 rr->taskPackage->packageName = 0;
324 rr->taskPackage->userId = 0;
325 rr->taskPackage->retentionTime = 0;
326 rr->taskPackage->permissions = 0;
327 rr->taskPackage->description = 0;
328 rr->taskPackage->targetReference = (Odr_oct *)
329 odr_malloc (rr->stream, sizeof(Odr_oct));
330 rr->taskPackage->targetReference->buf =
331 (unsigned char *) odr_strdup (rr->stream, "123");
332 rr->taskPackage->targetReference->len =
333 rr->taskPackage->targetReference->size =
334 strlen((char *) (rr->taskPackage->targetReference->buf));
335 rr->taskPackage->creationDateTime = 0;
336 rr->taskPackage->taskStatus = odr_intdup(rr->stream, 0);
337 rr->taskPackage->packageDiagnostics = 0;
338 rr->taskPackage->taskSpecificParameters = ext;
340 ext->direct_reference =
341 odr_oiddup (rr->stream, rr->esr->packageType);
342 ext->indirect_reference = 0;
344 ext->which = Z_External_update;
345 ext->u.update = (Z_IUUpdate *)
346 odr_malloc (rr->stream, sizeof(*ext->u.update));
347 ext->u.update->which = Z_IUUpdate_taskPackage;
348 ext->u.update->u.taskPackage = (Z_IUUpdateTaskPackage *)
349 odr_malloc (rr->stream, sizeof(Z_IUUpdateTaskPackage));
350 ext->u.update->u.taskPackage->originPart = keep;
351 ext->u.update->u.taskPackage->targetPart = targetPart;
353 keep->action = (int *) odr_malloc (rr->stream, sizeof(int));
354 *keep->action = *toKeep->action;
356 odr_strdup (rr->stream, toKeep->databaseName);
358 keep->elementSetName = 0;
359 keep->actionQualifier = 0;
361 targetPart->updateStatus = odr_intdup (rr->stream, 1);
362 targetPart->num_globalDiagnostics = 0;
363 targetPart->globalDiagnostics = (Z_DiagRec **) odr_nullval();
364 targetPart->num_taskPackageRecords = 1;
365 targetPart->taskPackageRecords =
366 (Z_IUTaskPackageRecordStructure **)
367 odr_malloc (rr->stream,
368 sizeof(Z_IUTaskPackageRecordStructure *));
369 targetPart->taskPackageRecords[0] =
370 (Z_IUTaskPackageRecordStructure *)
371 odr_malloc (rr->stream,
372 sizeof(Z_IUTaskPackageRecordStructure));
374 targetPart->taskPackageRecords[0]->which =
375 Z_IUTaskPackageRecordStructure_record;
376 targetPart->taskPackageRecords[0]->u.record =
377 z_ext_record_sutrs(rr->stream, "test", 4);
378 targetPart->taskPackageRecords[0]->correlationInfo = 0;
379 targetPart->taskPackageRecords[0]->recordStatus =
380 odr_intdup (rr->stream,
381 Z_IUTaskPackageRecordStructure_success);
382 targetPart->taskPackageRecords[0]->num_supplementalDiagnostics
385 targetPart->taskPackageRecords[0]->supplementalDiagnostics = 0;
390 for (i = 0; i < notToKeep->num; i++)
392 Z_External *rec = notToKeep->elements[i]->record;
394 if (rec->direct_reference)
396 char oid_name_str[OID_STR_MAX];
398 = oid_name = yaz_oid_to_string_buf(
399 rec->direct_reference, 0,
402 yaz_log (log_level, "record %d type %s", i,
407 case Z_External_sutrs:
408 if (rec->u.octet_aligned->len > 170)
409 yaz_log (log_level, "%d bytes:\n%.168s ...",
413 yaz_log (log_level, "%d bytes:\n%s",
417 case Z_External_octet :
418 if (rec->u.octet_aligned->len > 170)
419 yaz_log (log_level, "%d bytes:\n%.168s ...",
420 rec->u.octet_aligned->len,
421 rec->u.octet_aligned->buf);
423 yaz_log (log_level, "%d bytes\n%s",
424 rec->u.octet_aligned->len,
425 rec->u.octet_aligned->buf);
434 /* result set delete */
435 int ztest_delete (void *handle, bend_delete_rr *rr)
437 if (rr->num_setnames == 1 && !strcmp (rr->setnames[0], "1"))
438 rr->delete_status = Z_DeleteStatus_success;
440 rr->delete_status = Z_DeleteStatus_resultSetDidNotExist;
444 /* Our sort handler really doesn't sort... */
445 int ztest_sort (void *handle, bend_sort_rr *rr)
448 rr->sort_status = Z_SortResponse_success;
453 /* present request handler */
454 int ztest_present (void *handle, bend_present_rr *rr)
459 /* retrieval of a single record (present, and piggy back search) */
460 int ztest_fetch(void *handle, bend_fetch_rr *r)
464 char oid_str_buf[OID_STR_MAX];
465 const char *oid_str = 0;
466 const int *oid = r->request_format;
469 r->basename = "Default";
470 r->output_format = r->request_format;
472 oid_str = yaz_oid_to_string_buf(oid, &oclass, oid_str_buf);
474 if (oid && !oid_oidcmp(oid, yaz_oid_recsyn_sutrs))
476 /* this section returns a small record */
479 sprintf(buf, "This is dummy SUTRS record number %d\n", r->number);
481 r->len = strlen(buf);
482 r->record = (char *) odr_malloc (r->stream, r->len+1);
483 strcpy(r->record, buf);
485 else if (oid && !oid_oidcmp(oid, yaz_oid_recsyn_grs_1))
488 r->record = (char*) dummy_grs_record(r->number, r->stream);
495 else if (oid && !oid_oidcmp(oid, yaz_oid_recsyn_postscript))
501 sprintf (fname, "part.%d.ps", r->number);
502 f = fopen(fname, "rb");
508 fseek (f, 0L, SEEK_END);
510 if (size <= 0 || size >= 5000000)
515 fseek (f, 0L, SEEK_SET);
516 r->record = (char*) odr_malloc (r->stream, size);
518 fread (r->record, size, 1, f);
521 else if (oid && !oid_oidcmp(oid, yaz_oid_recsyn_xml))
523 if ((cp = dummy_xml_record (r->number, r->stream)))
531 r->surrogate_flag = 1;
535 else if ((cp = dummy_marc_record(r->number, r->stream)))
539 r->output_format = odr_oiddup(r->stream, yaz_oid_recsyn_usmarc);
551 * silly dummy-scan what reads words from a file.
553 int ztest_scan(void *handle, bend_scan_rr *q)
556 static struct scan_entry list[200];
557 static char entries[200][80];
561 int term_position_req = q->term_position;
562 int num_entries_req = q->num_entries;
564 /* Throw Database unavailable if other than Default or Slow */
565 if (!yaz_matchstr (q->basenames[0], "Default"))
566 ; /* Default is OK in our test */
567 else if(!yaz_matchstr (q->basenames[0], "Slow"))
577 q->errstring = q->basenames[0];
584 q->status = BEND_SCAN_SUCCESS;
585 if (!f && !(f = fopen("dummy-words", "r")))
587 perror("dummy-words");
590 if (q->num_entries > 200)
598 if (q->term->term->which != Z_Term_general)
600 q->errcode = 229; /* unsupported term type */
603 if (*q->step_size != 0)
605 q->errcode = 205; /*Only zero step size supported for Scan */
608 len = q->term->term->u.general->len;
609 if (len >= sizeof(term))
610 len = sizeof(term)-1;
611 memcpy(term, q->term->term->u.general->buf, len);
614 else if (q->scanClause)
616 strncpy(term, q->scanClause, sizeof(term)-1);
617 term[sizeof(term)-1] = '\0';
622 for (p = term; *p; p++)
623 if (islower(*(unsigned char *) p))
626 fseek(f, 0, SEEK_SET);
629 for (i = 0, pos = 0; fscanf(f, " %79[^:]:%d", entries[pos], &hits[pos]) == 2;
630 i++, pos < 199 ? pos++ : (pos = 0))
632 if (!q->num_entries && strcmp(entries[pos], term) >= 0) /* s-point fnd */
634 if ((q->term_position = term_position_req) > i + 1)
636 q->term_position = i + 1;
637 q->status = BEND_SCAN_PARTIAL;
639 for (; q->num_entries < q->term_position; q->num_entries++)
643 po = pos - q->term_position + q->num_entries+1; /* find pos */
647 if (!strcmp (term, "SD") && q->num_entries == 2)
649 list[q->num_entries].term = entries[pos];
650 list[q->num_entries].occurrences = -1;
651 list[q->num_entries].errcode = 233;
652 list[q->num_entries].errstring = "SD for Scan Term";
656 list[q->num_entries].term = entries[po];
657 list[q->num_entries].occurrences = hits[po];
661 else if (q->num_entries)
663 list[q->num_entries].term = entries[pos];
664 list[q->num_entries].occurrences = hits[pos];
667 if (q->num_entries >= num_entries_req)
671 q->status = BEND_SCAN_PARTIAL;
675 int ztest_explain(void *handle, bend_explain_rr *rr)
677 if (rr->database && !strcmp(rr->database, "Default"))
679 rr->explain_buf = "<explain>\n"
681 "\t\t<host>localhost</host>\n"
682 "\t\t<port>210</port>\n"
689 int ztest_update(void *handle, bend_update_rr *rr)
691 rr->operation_status = "success";
695 bend_initresult *bend_init(bend_initrequest *q)
697 bend_initresult *r = (bend_initresult *)
698 odr_malloc (q->stream, sizeof(*r));
699 int *counter = (int *) xmalloc (sizeof(int));
703 log_level=yaz_log_module_level("ztest");
710 r->handle = counter; /* user handle, in this case a simple int */
711 q->bend_sort = ztest_sort; /* register sort handler */
712 q->bend_search = ztest_search; /* register search handler */
713 q->bend_present = ztest_present; /* register present handle */
714 q->bend_esrequest = ztest_esrequest;
715 q->bend_delete = ztest_delete;
716 q->bend_fetch = ztest_fetch;
717 q->bend_scan = ztest_scan;
719 q->bend_explain = ztest_explain;
721 q->bend_srw_scan = ztest_scan;
722 q->bend_srw_update = ztest_update;
727 void bend_close(void *handle)
729 xfree (handle); /* release our user-defined handle */
733 int main(int argc, char **argv)
735 return statserv_main(argc, argv, bend_init, bend_close);
740 * indent-tabs-mode: nil
742 * vim: shiftwidth=4 tabstop=8 expandtab