2 * Copyright (C) 1995-2007, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: ztest.c,v 1.92 2007-05-30 08:04:28 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)
43 /* Throw Database unavailable if other than Default or Slow */
44 if (!yaz_matchstr (rr->basenames[0], "Default"))
45 ; /* Default is OK in our test */
46 else if(!yaz_matchstr (rr->basenames[0], "Slow"))
49 /* wait up to 3 seconds and check if connection is still alive */
53 if (!bend_assoc_is_alive(rr->association))
55 yaz_log(YLOG_LOG, "search aborted");
61 rr->estimated_hit_count = 1;
66 rr->errstring = rr->basenames[0];
69 rr->hits = rand() % 24;
74 /* this huge function handles extended services */
75 int ztest_esrequest (void *handle, bend_esrequest_rr *rr)
77 /* user-defined handle - created in bend_init */
78 int *counter = (int*) handle;
80 yaz_log(log_level, "ESRequest no %d", *counter);
84 if (rr->esr->packageName)
85 yaz_log(log_level, "packagename: %s", rr->esr->packageName);
86 yaz_log(log_level, "Waitaction: %d", *rr->esr->waitAction);
89 yaz_log(log_level, "function: %d", *rr->esr->function);
91 if (!rr->esr->taskSpecificParameters)
93 yaz_log (log_level, "No task specific parameters");
95 else if (rr->esr->taskSpecificParameters->which == Z_External_itemOrder)
97 Z_ItemOrder *it = rr->esr->taskSpecificParameters->u.itemOrder;
98 yaz_log (log_level, "Received ItemOrder");
99 if (it->which == Z_IOItemOrder_esRequest)
101 Z_IORequest *ir = it->u.esRequest;
102 Z_IOOriginPartToKeep *k = ir->toKeep;
103 Z_IOOriginPartNotToKeep *n = ir->notToKeep;
107 if (k->contact->name)
108 yaz_log(log_level, "contact name %s", k->contact->name);
109 if (k->contact->phone)
110 yaz_log(log_level, "contact phone %s", k->contact->phone);
111 if (k->contact->email)
112 yaz_log(log_level, "contact email %s", k->contact->email);
116 yaz_log(log_level, "Billing info (not shown)");
119 if (n->resultSetItem)
121 yaz_log(log_level, "resultsetItem");
122 yaz_log(log_level, "setId: %s", n->resultSetItem->resultSetId);
123 yaz_log(log_level, "item: %d", *n->resultSetItem->item);
127 Z_External *r = (Z_External*) n->itemRequest;
128 ILL_ItemRequest *item_req = 0;
129 ILL_APDU *ill_apdu = 0;
130 if (r->direct_reference)
132 char oid_name_str[OID_STR_MAX];
134 const char *oid_name =
135 yaz_oid_to_string_buf(r->direct_reference,
136 &oclass, oid_name_str);
138 yaz_log(log_level, "OID %s", oid_name);
139 if (!oid_oidcmp(r->direct_reference, yaz_oid_recsyn_xml))
141 yaz_log (log_level, "ILL XML request");
142 if (r->which == Z_External_octet)
143 yaz_log (log_level, "%.*s", r->u.octet_aligned->len,
144 r->u.octet_aligned->buf);
146 if (!oid_oidcmp(r->direct_reference,
147 yaz_oid_general_isoill_1))
149 yaz_log (log_level, "Decode ItemRequest begin");
150 if (r->which == ODR_EXTERNAL_single)
152 odr_setbuf(rr->decode,
153 (char *) r->u.single_ASN1_type->buf,
154 r->u.single_ASN1_type->len, 0);
156 if (!ill_ItemRequest (rr->decode, &item_req, 0, 0))
159 "Couldn't decode ItemRequest %s near %ld",
160 odr_errmsg(odr_geterror(rr->decode)),
161 (long) odr_offset(rr->decode));
164 yaz_log(log_level, "Decode ItemRequest OK");
167 ill_ItemRequest (rr->print, &item_req, 0,
169 odr_reset (rr->print);
172 if (!item_req && r->which == ODR_EXTERNAL_single)
174 yaz_log (log_level, "Decode ILL APDU begin");
175 odr_setbuf(rr->decode,
176 (char*) r->u.single_ASN1_type->buf,
177 r->u.single_ASN1_type->len, 0);
179 if (!ill_APDU (rr->decode, &ill_apdu, 0, 0))
182 "Couldn't decode ILL APDU %s near %ld",
183 odr_errmsg(odr_geterror(rr->decode)),
184 (long) odr_offset(rr->decode));
185 yaz_log(log_level, "PDU dump:");
186 odr_dumpBER(yaz_log_file(),
187 (char *) r->u.single_ASN1_type->buf,
188 r->u.single_ASN1_type->len);
191 yaz_log(log_level, "Decode ILL APDU OK");
194 ill_APDU (rr->print, &ill_apdu, 0,
196 odr_reset (rr->print);
203 yaz_log (log_level, "ILL protocol version = %d",
204 *item_req->protocol_version_num);
210 Z_External *ext = (Z_External *)
211 odr_malloc (rr->stream, sizeof(*ext));
212 Z_IUOriginPartToKeep *keep = (Z_IUOriginPartToKeep *)
213 odr_malloc (rr->stream, sizeof(*keep));
214 Z_IOTargetPart *targetPart = (Z_IOTargetPart *)
215 odr_malloc (rr->stream, sizeof(*targetPart));
217 rr->taskPackage = (Z_TaskPackage *)
218 odr_malloc (rr->stream, sizeof(*rr->taskPackage));
219 rr->taskPackage->packageType =
220 odr_oiddup (rr->stream, rr->esr->packageType);
221 rr->taskPackage->packageName = 0;
222 rr->taskPackage->userId = 0;
223 rr->taskPackage->retentionTime = 0;
224 rr->taskPackage->permissions = 0;
225 rr->taskPackage->description = 0;
226 rr->taskPackage->targetReference = (Odr_oct *)
227 odr_malloc (rr->stream, sizeof(Odr_oct));
228 rr->taskPackage->targetReference->buf =
229 (unsigned char *) odr_strdup (rr->stream, "911");
230 rr->taskPackage->targetReference->len =
231 rr->taskPackage->targetReference->size =
232 strlen((char *) (rr->taskPackage->targetReference->buf));
233 rr->taskPackage->creationDateTime = 0;
234 rr->taskPackage->taskStatus = odr_intdup(rr->stream, 0);
235 rr->taskPackage->packageDiagnostics = 0;
236 rr->taskPackage->taskSpecificParameters = ext;
238 ext->direct_reference =
239 odr_oiddup (rr->stream, rr->esr->packageType);
240 ext->indirect_reference = 0;
242 ext->which = Z_External_itemOrder;
243 ext->u.itemOrder = (Z_ItemOrder *)
244 odr_malloc (rr->stream, sizeof(*ext->u.update));
245 ext->u.itemOrder->which = Z_IOItemOrder_taskPackage;
246 ext->u.itemOrder->u.taskPackage = (Z_IOTaskPackage *)
247 odr_malloc (rr->stream, sizeof(Z_IOTaskPackage));
248 ext->u.itemOrder->u.taskPackage->originPart = k;
249 ext->u.itemOrder->u.taskPackage->targetPart = targetPart;
251 targetPart->itemRequest = 0;
252 targetPart->statusOrErrorReport = 0;
253 targetPart->auxiliaryStatus = 0;
257 else if (rr->esr->taskSpecificParameters->which == Z_External_update)
259 Z_IUUpdate *up = rr->esr->taskSpecificParameters->u.update;
260 yaz_log (log_level, "Received DB Update");
261 if (up->which == Z_IUUpdate_esRequest)
263 Z_IUUpdateEsRequest *esRequest = up->u.esRequest;
264 Z_IUOriginPartToKeep *toKeep = esRequest->toKeep;
265 Z_IUSuppliedRecords *notToKeep = esRequest->notToKeep;
267 yaz_log (log_level, "action");
270 switch (*toKeep->action)
272 case Z_IUOriginPartToKeep_recordInsert:
273 yaz_log (log_level, " recordInsert");
275 case Z_IUOriginPartToKeep_recordReplace:
276 yaz_log (log_level, " recordReplace");
278 case Z_IUOriginPartToKeep_recordDelete:
279 yaz_log (log_level, " recordDelete");
281 case Z_IUOriginPartToKeep_elementUpdate:
282 yaz_log (log_level, " elementUpdate");
284 case Z_IUOriginPartToKeep_specialUpdate:
285 yaz_log (log_level, " specialUpdate");
288 yaz_log (log_level, " unknown (%d)", *toKeep->action);
291 if (toKeep->databaseName)
293 yaz_log (log_level, "database: %s", toKeep->databaseName);
294 if (!strcmp(toKeep->databaseName, "fault"))
297 rr->errstring = toKeep->databaseName;
299 if (!strcmp(toKeep->databaseName, "accept"))
304 Z_External *ext = (Z_External *)
305 odr_malloc (rr->stream, sizeof(*ext));
306 Z_IUOriginPartToKeep *keep = (Z_IUOriginPartToKeep *)
307 odr_malloc (rr->stream, sizeof(*keep));
308 Z_IUTargetPart *targetPart = (Z_IUTargetPart *)
309 odr_malloc (rr->stream, sizeof(*targetPart));
311 rr->taskPackage = (Z_TaskPackage *)
312 odr_malloc (rr->stream, sizeof(*rr->taskPackage));
313 rr->taskPackage->packageType =
314 odr_oiddup (rr->stream, rr->esr->packageType);
315 rr->taskPackage->packageName = 0;
316 rr->taskPackage->userId = 0;
317 rr->taskPackage->retentionTime = 0;
318 rr->taskPackage->permissions = 0;
319 rr->taskPackage->description = 0;
320 rr->taskPackage->targetReference = (Odr_oct *)
321 odr_malloc (rr->stream, sizeof(Odr_oct));
322 rr->taskPackage->targetReference->buf =
323 (unsigned char *) odr_strdup (rr->stream, "123");
324 rr->taskPackage->targetReference->len =
325 rr->taskPackage->targetReference->size =
326 strlen((char *) (rr->taskPackage->targetReference->buf));
327 rr->taskPackage->creationDateTime = 0;
328 rr->taskPackage->taskStatus = odr_intdup(rr->stream, 0);
329 rr->taskPackage->packageDiagnostics = 0;
330 rr->taskPackage->taskSpecificParameters = ext;
332 ext->direct_reference =
333 odr_oiddup (rr->stream, rr->esr->packageType);
334 ext->indirect_reference = 0;
336 ext->which = Z_External_update;
337 ext->u.update = (Z_IUUpdate *)
338 odr_malloc (rr->stream, sizeof(*ext->u.update));
339 ext->u.update->which = Z_IUUpdate_taskPackage;
340 ext->u.update->u.taskPackage = (Z_IUUpdateTaskPackage *)
341 odr_malloc (rr->stream, sizeof(Z_IUUpdateTaskPackage));
342 ext->u.update->u.taskPackage->originPart = keep;
343 ext->u.update->u.taskPackage->targetPart = targetPart;
345 keep->action = (int *) odr_malloc (rr->stream, sizeof(int));
346 *keep->action = *toKeep->action;
348 odr_strdup (rr->stream, toKeep->databaseName);
350 keep->elementSetName = 0;
351 keep->actionQualifier = 0;
353 targetPart->updateStatus = odr_intdup (rr->stream, 1);
354 targetPart->num_globalDiagnostics = 0;
355 targetPart->globalDiagnostics = (Z_DiagRec **) odr_nullval();
356 targetPart->num_taskPackageRecords = 1;
357 targetPart->taskPackageRecords =
358 (Z_IUTaskPackageRecordStructure **)
359 odr_malloc (rr->stream,
360 sizeof(Z_IUTaskPackageRecordStructure *));
361 targetPart->taskPackageRecords[0] =
362 (Z_IUTaskPackageRecordStructure *)
363 odr_malloc (rr->stream,
364 sizeof(Z_IUTaskPackageRecordStructure));
366 targetPart->taskPackageRecords[0]->which =
367 Z_IUTaskPackageRecordStructure_record;
368 targetPart->taskPackageRecords[0]->u.record =
369 z_ext_record_sutrs(rr->stream, "test", 4);
370 targetPart->taskPackageRecords[0]->correlationInfo = 0;
371 targetPart->taskPackageRecords[0]->recordStatus =
372 odr_intdup (rr->stream,
373 Z_IUTaskPackageRecordStructure_success);
374 targetPart->taskPackageRecords[0]->num_supplementalDiagnostics
377 targetPart->taskPackageRecords[0]->supplementalDiagnostics = 0;
382 for (i = 0; i < notToKeep->num; i++)
384 Z_External *rec = notToKeep->elements[i]->record;
386 if (rec->direct_reference)
388 char oid_name_str[OID_STR_MAX];
390 = oid_name = yaz_oid_to_string_buf(
391 rec->direct_reference, 0,
394 yaz_log (log_level, "record %d type %s", i,
399 case Z_External_sutrs:
400 if (rec->u.octet_aligned->len > 170)
401 yaz_log (log_level, "%d bytes:\n%.168s ...",
405 yaz_log (log_level, "%d bytes:\n%s",
409 case Z_External_octet :
410 if (rec->u.octet_aligned->len > 170)
411 yaz_log (log_level, "%d bytes:\n%.168s ...",
412 rec->u.octet_aligned->len,
413 rec->u.octet_aligned->buf);
415 yaz_log (log_level, "%d bytes\n%s",
416 rec->u.octet_aligned->len,
417 rec->u.octet_aligned->buf);
426 /* result set delete */
427 int ztest_delete (void *handle, bend_delete_rr *rr)
429 if (rr->num_setnames == 1 && !strcmp (rr->setnames[0], "1"))
430 rr->delete_status = Z_DeleteStatus_success;
432 rr->delete_status = Z_DeleteStatus_resultSetDidNotExist;
436 /* Our sort handler really doesn't sort... */
437 int ztest_sort (void *handle, bend_sort_rr *rr)
440 rr->sort_status = Z_SortResponse_success;
445 /* present request handler */
446 int ztest_present (void *handle, bend_present_rr *rr)
451 /* retrieval of a single record (present, and piggy back search) */
452 int ztest_fetch(void *handle, bend_fetch_rr *r)
456 char oid_str_buf[OID_STR_MAX];
457 const char *oid_str = 0;
458 const Odr_oid *oid = r->request_format;
461 r->basename = "Default";
462 r->output_format = r->request_format;
464 oid_str = yaz_oid_to_string_buf(oid, &oclass, oid_str_buf);
466 if (oid && !oid_oidcmp(oid, yaz_oid_recsyn_sutrs))
468 /* this section returns a small record */
471 sprintf(buf, "This is dummy SUTRS record number %d\n", r->number);
473 r->len = strlen(buf);
474 r->record = (char *) odr_malloc (r->stream, r->len+1);
475 strcpy(r->record, buf);
477 else if (oid && !oid_oidcmp(oid, yaz_oid_recsyn_grs_1))
480 r->record = (char*) dummy_grs_record(r->number, r->stream);
487 else if (oid && !oid_oidcmp(oid, yaz_oid_recsyn_postscript))
493 sprintf (fname, "part.%d.ps", r->number);
494 f = fopen(fname, "rb");
500 fseek (f, 0L, SEEK_END);
502 if (size <= 0 || size >= 5000000)
507 fseek (f, 0L, SEEK_SET);
508 r->record = (char*) odr_malloc (r->stream, size);
510 fread (r->record, size, 1, f);
513 else if (oid && !oid_oidcmp(oid, yaz_oid_recsyn_xml))
515 if ((cp = dummy_xml_record (r->number, r->stream)))
523 r->surrogate_flag = 1;
527 else if ((cp = dummy_marc_record(r->number, r->stream)))
531 r->output_format = odr_oiddup(r->stream, yaz_oid_recsyn_usmarc);
543 * silly dummy-scan what reads words from a file.
545 int ztest_scan(void *handle, bend_scan_rr *q)
548 static struct scan_entry list[200];
549 static char entries[200][80];
553 int term_position_req = q->term_position;
554 int num_entries_req = q->num_entries;
556 /* Throw Database unavailable if other than Default or Slow */
557 if (!yaz_matchstr (q->basenames[0], "Default"))
558 ; /* Default is OK in our test */
559 else if(!yaz_matchstr (q->basenames[0], "Slow"))
569 q->errstring = q->basenames[0];
576 q->status = BEND_SCAN_SUCCESS;
577 if (!f && !(f = fopen("dummy-words", "r")))
579 perror("dummy-words");
582 if (q->num_entries > 200)
590 if (q->term->term->which != Z_Term_general)
592 q->errcode = 229; /* unsupported term type */
595 if (*q->step_size != 0)
597 q->errcode = 205; /*Only zero step size supported for Scan */
600 len = q->term->term->u.general->len;
601 if (len >= sizeof(term))
602 len = sizeof(term)-1;
603 memcpy(term, q->term->term->u.general->buf, len);
606 else if (q->scanClause)
608 strncpy(term, q->scanClause, sizeof(term)-1);
609 term[sizeof(term)-1] = '\0';
614 for (p = term; *p; p++)
615 if (islower(*(unsigned char *) p))
618 fseek(f, 0, SEEK_SET);
621 for (i = 0, pos = 0; fscanf(f, " %79[^:]:%d", entries[pos], &hits[pos]) == 2;
622 i++, pos < 199 ? pos++ : (pos = 0))
624 if (!q->num_entries && strcmp(entries[pos], term) >= 0) /* s-point fnd */
626 if ((q->term_position = term_position_req) > i + 1)
628 q->term_position = i + 1;
629 q->status = BEND_SCAN_PARTIAL;
631 for (; q->num_entries < q->term_position; q->num_entries++)
635 po = pos - q->term_position + q->num_entries+1; /* find pos */
639 if (!strcmp (term, "SD") && q->num_entries == 2)
641 list[q->num_entries].term = entries[pos];
642 list[q->num_entries].occurrences = -1;
643 list[q->num_entries].errcode = 233;
644 list[q->num_entries].errstring = "SD for Scan Term";
648 list[q->num_entries].term = entries[po];
649 list[q->num_entries].occurrences = hits[po];
653 else if (q->num_entries)
655 list[q->num_entries].term = entries[pos];
656 list[q->num_entries].occurrences = hits[pos];
659 if (q->num_entries >= num_entries_req)
663 q->status = BEND_SCAN_PARTIAL;
667 int ztest_explain(void *handle, bend_explain_rr *rr)
669 if (rr->database && !strcmp(rr->database, "Default"))
671 rr->explain_buf = "<explain>\n"
673 "\t\t<host>localhost</host>\n"
674 "\t\t<port>210</port>\n"
681 int ztest_update(void *handle, bend_update_rr *rr)
683 rr->operation_status = "success";
687 bend_initresult *bend_init(bend_initrequest *q)
689 bend_initresult *r = (bend_initresult *)
690 odr_malloc (q->stream, sizeof(*r));
691 int *counter = (int *) xmalloc (sizeof(int));
695 log_level=yaz_log_module_level("ztest");
702 r->handle = counter; /* user handle, in this case a simple int */
703 q->bend_sort = ztest_sort; /* register sort handler */
704 q->bend_search = ztest_search; /* register search handler */
705 q->bend_present = ztest_present; /* register present handle */
706 q->bend_esrequest = ztest_esrequest;
707 q->bend_delete = ztest_delete;
708 q->bend_fetch = ztest_fetch;
709 q->bend_scan = ztest_scan;
711 q->bend_explain = ztest_explain;
713 q->bend_srw_scan = ztest_scan;
714 q->bend_srw_update = ztest_update;
716 q->query_charset = "ISO-8859-1";
717 q->records_in_same_charset = 0;
722 void bend_close(void *handle)
724 xfree (handle); /* release our user-defined handle */
728 int main(int argc, char **argv)
730 return statserv_main(argc, argv, bend_init, bend_close);
735 * indent-tabs-mode: nil
737 * vim: shiftwidth=4 tabstop=8 expandtab