2 * Copyright (c) 1995-2003, Index Data.
3 * See the file LICENSE for details.
5 * $Id: ztest.c,v 1.60 2004-01-15 10:04:39 adam Exp $
9 * Demonstration of simple server
16 #include <yaz/yaz-util.h>
17 #include <yaz/backend.h>
20 Z_GenericRecord *dummy_grs_record (int num, ODR o);
21 char *dummy_marc_record (int num, ODR odr);
22 char *dummy_xml_record (int num, ODR odr);
24 int ztest_search (void *handle, bend_search_rr *rr);
25 int ztest_sort (void *handle, bend_sort_rr *rr);
26 int ztest_present (void *handle, bend_present_rr *rr);
27 int ztest_esrequest (void *handle, bend_esrequest_rr *rr);
28 int ztest_delete (void *handle, bend_delete_rr *rr);
30 int ztest_search (void *handle, bend_search_rr *rr)
32 if (rr->num_bases != 1)
37 /* if database is stop, stop this process.. For debugging only.
38 if (!yaz_matchstr (rr->basenames[0], "stop"))
40 nmem_print_list_l(LOG_LOG);
43 /* Throw Database unavailable if other than Default */
44 if (yaz_matchstr (rr->basenames[0], "Default"))
47 rr->errstring = rr->basenames[0];
50 rr->hits = rand() % 24;
55 /* this huge function handles extended services */
56 int ztest_esrequest (void *handle, bend_esrequest_rr *rr)
58 /* user-defined handle - created in bend_init */
59 int *counter = (int*) handle;
61 yaz_log(LOG_LOG, "ESRequest no %d", *counter);
65 if (rr->esr->packageName)
66 yaz_log(LOG_LOG, "packagename: %s", rr->esr->packageName);
67 yaz_log(LOG_LOG, "Waitaction: %d", *rr->esr->waitAction);
70 yaz_log(LOG_LOG, "function: %d", *rr->esr->function);
72 if (!rr->esr->taskSpecificParameters)
74 yaz_log (LOG_WARN, "No task specific parameters");
76 else if (rr->esr->taskSpecificParameters->which == Z_External_itemOrder)
78 Z_ItemOrder *it = rr->esr->taskSpecificParameters->u.itemOrder;
79 yaz_log (LOG_LOG, "Received ItemOrder");
80 if (it->which == Z_IOItemOrder_esRequest)
82 Z_IORequest *ir = it->u.esRequest;
83 Z_IOOriginPartToKeep *k = ir->toKeep;
84 Z_IOOriginPartNotToKeep *n = ir->notToKeep;
89 yaz_log(LOG_LOG, "contact name %s", k->contact->name);
90 if (k->contact->phone)
91 yaz_log(LOG_LOG, "contact phone %s", k->contact->phone);
92 if (k->contact->email)
93 yaz_log(LOG_LOG, "contact email %s", k->contact->email);
97 yaz_log(LOG_LOG, "Billing info (not shown)");
100 if (n->resultSetItem)
102 yaz_log(LOG_LOG, "resultsetItem");
103 yaz_log(LOG_LOG, "setId: %s", n->resultSetItem->resultSetId);
104 yaz_log(LOG_LOG, "item: %d", *n->resultSetItem->item);
108 Z_External *r = (Z_External*) n->itemRequest;
109 ILL_ItemRequest *item_req = 0;
110 ILL_APDU *ill_apdu = 0;
111 if (r->direct_reference)
113 oident *ent = oid_getentbyoid(r->direct_reference);
115 yaz_log(LOG_LOG, "OID %s", ent->desc);
116 if (ent && ent->value == VAL_TEXT_XML)
118 yaz_log (LOG_LOG, "ILL XML request");
119 if (r->which == Z_External_octet)
120 yaz_log (LOG_LOG, "%.*s", r->u.octet_aligned->len,
121 r->u.octet_aligned->buf);
123 if (ent && ent->value == VAL_ISO_ILL_1)
125 yaz_log (LOG_LOG, "Decode ItemRequest begin");
126 if (r->which == ODR_EXTERNAL_single)
128 odr_setbuf(rr->decode,
129 (char *) r->u.single_ASN1_type->buf,
130 r->u.single_ASN1_type->len, 0);
132 if (!ill_ItemRequest (rr->decode, &item_req, 0, 0))
135 "Couldn't decode ItemRequest %s near %d",
136 odr_errmsg(odr_geterror(rr->decode)),
137 odr_offset(rr->decode));
140 yaz_log(LOG_LOG, "Decode ItemRequest OK");
143 ill_ItemRequest (rr->print, &item_req, 0,
145 odr_reset (rr->print);
148 if (!item_req && r->which == ODR_EXTERNAL_single)
150 yaz_log (LOG_LOG, "Decode ILL APDU begin");
151 odr_setbuf(rr->decode,
152 (char*) r->u.single_ASN1_type->buf,
153 r->u.single_ASN1_type->len, 0);
155 if (!ill_APDU (rr->decode, &ill_apdu, 0, 0))
158 "Couldn't decode ILL APDU %s near %d",
159 odr_errmsg(odr_geterror(rr->decode)),
160 odr_offset(rr->decode));
161 yaz_log(LOG_LOG, "PDU dump:");
162 odr_dumpBER(yaz_log_file(),
163 (char *) r->u.single_ASN1_type->buf,
164 r->u.single_ASN1_type->len);
167 yaz_log(LOG_LOG, "Decode ILL APDU OK");
170 ill_APDU (rr->print, &ill_apdu, 0,
172 odr_reset (rr->print);
179 yaz_log (LOG_LOG, "ILL protocol version = %d",
180 *item_req->protocol_version_num);
186 Z_External *ext = (Z_External *)
187 odr_malloc (rr->stream, sizeof(*ext));
188 Z_IUOriginPartToKeep *keep = (Z_IUOriginPartToKeep *)
189 odr_malloc (rr->stream, sizeof(*keep));
190 Z_IOTargetPart *targetPart = (Z_IOTargetPart *)
191 odr_malloc (rr->stream, sizeof(*targetPart));
193 rr->taskPackage = (Z_TaskPackage *)
194 odr_malloc (rr->stream, sizeof(*rr->taskPackage));
195 rr->taskPackage->packageType =
196 odr_oiddup (rr->stream, rr->esr->packageType);
197 rr->taskPackage->packageName = 0;
198 rr->taskPackage->userId = 0;
199 rr->taskPackage->retentionTime = 0;
200 rr->taskPackage->permissions = 0;
201 rr->taskPackage->description = 0;
202 rr->taskPackage->targetReference = (Odr_oct *)
203 odr_malloc (rr->stream, sizeof(Odr_oct));
204 rr->taskPackage->targetReference->buf =
205 (unsigned char *) odr_strdup (rr->stream, "911");
206 rr->taskPackage->targetReference->len =
207 rr->taskPackage->targetReference->size =
208 strlen((char *) (rr->taskPackage->targetReference->buf));
209 rr->taskPackage->creationDateTime = 0;
210 rr->taskPackage->taskStatus = odr_intdup(rr->stream, 0);
211 rr->taskPackage->packageDiagnostics = 0;
212 rr->taskPackage->taskSpecificParameters = ext;
214 ext->direct_reference =
215 odr_oiddup (rr->stream, rr->esr->packageType);
216 ext->indirect_reference = 0;
218 ext->which = Z_External_itemOrder;
219 ext->u.itemOrder = (Z_ItemOrder *)
220 odr_malloc (rr->stream, sizeof(*ext->u.update));
221 ext->u.itemOrder->which = Z_IOItemOrder_taskPackage;
222 ext->u.itemOrder->u.taskPackage = (Z_IOTaskPackage *)
223 odr_malloc (rr->stream, sizeof(Z_IOTaskPackage));
224 ext->u.itemOrder->u.taskPackage->originPart = k;
225 ext->u.itemOrder->u.taskPackage->targetPart = targetPart;
227 targetPart->itemRequest = 0;
228 targetPart->statusOrErrorReport = 0;
229 targetPart->auxiliaryStatus = 0;
233 else if (rr->esr->taskSpecificParameters->which == Z_External_update)
235 Z_IUUpdate *up = rr->esr->taskSpecificParameters->u.update;
236 yaz_log (LOG_LOG, "Received DB Update");
237 if (up->which == Z_IUUpdate_esRequest)
239 Z_IUUpdateEsRequest *esRequest = up->u.esRequest;
240 Z_IUOriginPartToKeep *toKeep = esRequest->toKeep;
241 Z_IUSuppliedRecords *notToKeep = esRequest->notToKeep;
243 yaz_log (LOG_LOG, "action");
246 switch (*toKeep->action)
248 case Z_IUOriginPartToKeep_recordInsert:
249 yaz_log (LOG_LOG, " recordInsert");
251 case Z_IUOriginPartToKeep_recordReplace:
252 yaz_log (LOG_LOG, " recordReplace");
254 case Z_IUOriginPartToKeep_recordDelete:
255 yaz_log (LOG_LOG, " recordDelete");
257 case Z_IUOriginPartToKeep_elementUpdate:
258 yaz_log (LOG_LOG, " elementUpdate");
260 case Z_IUOriginPartToKeep_specialUpdate:
261 yaz_log (LOG_LOG, " specialUpdate");
264 yaz_log (LOG_LOG, " unknown (%d)", *toKeep->action);
267 if (toKeep->databaseName)
269 yaz_log (LOG_LOG, "database: %s", toKeep->databaseName);
270 if (!strcmp(toKeep->databaseName, "fault"))
273 rr->errstring = toKeep->databaseName;
275 if (!strcmp(toKeep->databaseName, "accept"))
280 Z_External *ext = (Z_External *)
281 odr_malloc (rr->stream, sizeof(*ext));
282 Z_IUOriginPartToKeep *keep = (Z_IUOriginPartToKeep *)
283 odr_malloc (rr->stream, sizeof(*keep));
284 Z_IUTargetPart *targetPart = (Z_IUTargetPart *)
285 odr_malloc (rr->stream, sizeof(*targetPart));
287 rr->taskPackage = (Z_TaskPackage *)
288 odr_malloc (rr->stream, sizeof(*rr->taskPackage));
289 rr->taskPackage->packageType =
290 odr_oiddup (rr->stream, rr->esr->packageType);
291 rr->taskPackage->packageName = 0;
292 rr->taskPackage->userId = 0;
293 rr->taskPackage->retentionTime = 0;
294 rr->taskPackage->permissions = 0;
295 rr->taskPackage->description = 0;
296 rr->taskPackage->targetReference = (Odr_oct *)
297 odr_malloc (rr->stream, sizeof(Odr_oct));
298 rr->taskPackage->targetReference->buf =
299 (unsigned char *) odr_strdup (rr->stream, "123");
300 rr->taskPackage->targetReference->len =
301 rr->taskPackage->targetReference->size =
302 strlen((char *) (rr->taskPackage->targetReference->buf));
303 rr->taskPackage->creationDateTime = 0;
304 rr->taskPackage->taskStatus = odr_intdup(rr->stream, 0);
305 rr->taskPackage->packageDiagnostics = 0;
306 rr->taskPackage->taskSpecificParameters = ext;
308 ext->direct_reference =
309 odr_oiddup (rr->stream, rr->esr->packageType);
310 ext->indirect_reference = 0;
312 ext->which = Z_External_update;
313 ext->u.update = (Z_IUUpdate *)
314 odr_malloc (rr->stream, sizeof(*ext->u.update));
315 ext->u.update->which = Z_IUUpdate_taskPackage;
316 ext->u.update->u.taskPackage = (Z_IUUpdateTaskPackage *)
317 odr_malloc (rr->stream, sizeof(Z_IUUpdateTaskPackage));
318 ext->u.update->u.taskPackage->originPart = keep;
319 ext->u.update->u.taskPackage->targetPart = targetPart;
321 keep->action = (int *) odr_malloc (rr->stream, sizeof(int));
322 *keep->action = *toKeep->action;
324 odr_strdup (rr->stream, toKeep->databaseName);
326 keep->elementSetName = 0;
327 keep->actionQualifier = 0;
329 targetPart->updateStatus = odr_intdup (rr->stream, 1);
330 targetPart->num_globalDiagnostics = 0;
331 targetPart->globalDiagnostics = (Z_DiagRec **) odr_nullval();
332 targetPart->num_taskPackageRecords = 1;
333 targetPart->taskPackageRecords =
334 (Z_IUTaskPackageRecordStructure **)
335 odr_malloc (rr->stream,
336 sizeof(Z_IUTaskPackageRecordStructure *));
337 targetPart->taskPackageRecords[0] =
338 (Z_IUTaskPackageRecordStructure *)
339 odr_malloc (rr->stream,
340 sizeof(Z_IUTaskPackageRecordStructure));
342 targetPart->taskPackageRecords[0]->which =
343 Z_IUTaskPackageRecordStructure_record;
344 targetPart->taskPackageRecords[0]->u.record =
345 z_ext_record (rr->stream, VAL_SUTRS, "test", 4);
346 targetPart->taskPackageRecords[0]->correlationInfo = 0;
347 targetPart->taskPackageRecords[0]->recordStatus =
348 odr_intdup (rr->stream,
349 Z_IUTaskPackageRecordStructure_success);
350 targetPart->taskPackageRecords[0]->num_supplementalDiagnostics
353 targetPart->taskPackageRecords[0]->supplementalDiagnostics = 0;
358 for (i = 0; i < notToKeep->num; i++)
360 Z_External *rec = notToKeep->elements[i]->record;
362 if (rec->direct_reference)
364 struct oident *oident;
365 oident = oid_getentbyoid(rec->direct_reference);
367 yaz_log (LOG_LOG, "record %d type %s", i,
372 case Z_External_sutrs:
373 if (rec->u.octet_aligned->len > 170)
374 yaz_log (LOG_LOG, "%d bytes:\n%.168s ...",
378 yaz_log (LOG_LOG, "%d bytes:\n%s",
382 case Z_External_octet :
383 if (rec->u.octet_aligned->len > 170)
384 yaz_log (LOG_LOG, "%d bytes:\n%.168s ...",
385 rec->u.octet_aligned->len,
386 rec->u.octet_aligned->buf);
388 yaz_log (LOG_LOG, "%d bytes\n%s",
389 rec->u.octet_aligned->len,
390 rec->u.octet_aligned->buf);
396 else if (rr->esr->taskSpecificParameters->which == Z_External_update0)
398 yaz_log(LOG_LOG, "Received DB Update (version 0)");
402 yaz_log (LOG_WARN, "Unknown Extended Service(%d)",
403 rr->esr->taskSpecificParameters->which);
409 /* result set delete */
410 int ztest_delete (void *handle, bend_delete_rr *rr)
412 if (rr->num_setnames == 1 && !strcmp (rr->setnames[0], "1"))
413 rr->delete_status = Z_DeleteStatus_success;
415 rr->delete_status = Z_DeleteStatus_resultSetDidNotExist;
419 /* Our sort handler really doesn't sort... */
420 int ztest_sort (void *handle, bend_sort_rr *rr)
423 rr->sort_status = Z_SortStatus_success;
428 /* present request handler */
429 int ztest_present (void *handle, bend_present_rr *rr)
434 /* retrieval of a single record (present, and piggy back search) */
435 int ztest_fetch(void *handle, bend_fetch_rr *r)
440 r->basename = "Default";
441 r->output_format = r->request_format;
442 if (r->request_format == VAL_SUTRS)
444 /* this section returns a small record */
447 sprintf(buf, "This is dummy SUTRS record number %d\n", r->number);
449 r->len = strlen(buf);
450 r->record = (char *) odr_malloc (r->stream, r->len+1);
451 strcpy(r->record, buf);
453 else if (r->request_format == VAL_GRS1)
456 r->record = (char*) dummy_grs_record(r->number, r->stream);
463 else if (r->request_format == VAL_POSTSCRIPT)
469 sprintf (fname, "part.%d.ps", r->number);
470 f = fopen(fname, "rb");
476 fseek (f, 0L, SEEK_END);
478 if (size <= 0 || size >= 5000000)
483 fseek (f, 0L, SEEK_SET);
484 r->record = (char*) odr_malloc (r->stream, size);
486 r->output_format = VAL_POSTSCRIPT;
487 fread (r->record, size, 1, f);
490 else if (r->request_format == VAL_TEXT_XML &&
491 (cp = dummy_xml_record (r->number, r->stream)))
495 r->output_format = VAL_TEXT_XML;
497 else if ((cp = dummy_marc_record(r->number, r->stream)))
501 r->output_format = VAL_USMARC;
513 * silly dummy-scan what reads words from a file.
515 int ztest_scan(void *handle, bend_scan_rr *q)
518 static struct scan_entry list[200];
519 static char entries[200][80];
523 int term_position_req = q->term_position;
524 int num_entries_req = q->num_entries;
529 q->status = BEND_SCAN_SUCCESS;
530 if (!f && !(f = fopen("dummy-words", "r")))
532 perror("dummy-words");
535 if (q->term->term->which != Z_Term_general)
537 q->errcode = 229; /* unsupported term type */
540 if (*q->step_size != 0)
542 q->errcode = 205; /*Only zero step size supported for Scan */
545 if (q->term->term->u.general->len >= 80)
547 q->errcode = 11; /* term too long */
550 if (q->num_entries > 200)
555 memcpy(term, q->term->term->u.general->buf, q->term->term->u.general->len);
556 term[q->term->term->u.general->len] = '\0';
557 for (p = term; *p; p++)
561 fseek(f, 0, SEEK_SET);
564 for (i = 0, pos = 0; fscanf(f, " %79[^:]:%d", entries[pos], &hits[pos]) == 2;
565 i++, pos < 199 ? pos++ : (pos = 0))
567 if (!q->num_entries && strcmp(entries[pos], term) >= 0) /* s-point fnd */
569 if ((q->term_position = term_position_req) > i + 1)
571 q->term_position = i + 1;
572 q->status = BEND_SCAN_PARTIAL;
574 for (; q->num_entries < q->term_position; q->num_entries++)
578 po = pos - q->term_position + q->num_entries+1; /* find pos */
582 if (!strcmp (term, "SD") && q->num_entries == 2)
584 list[q->num_entries].term = entries[pos];
585 list[q->num_entries].occurrences = -1;
586 list[q->num_entries].errcode = 233;
587 list[q->num_entries].errstring = "SD for Scan Term";
591 list[q->num_entries].term = entries[po];
592 list[q->num_entries].occurrences = hits[po];
596 else if (q->num_entries)
598 list[q->num_entries].term = entries[pos];
599 list[q->num_entries].occurrences = hits[pos];
602 if (q->num_entries >= num_entries_req)
606 q->status = BEND_SCAN_PARTIAL;
610 static int ztest_explain(void *handle, bend_explain_rr *rr)
612 if (rr->database && !strcmp(rr->database, "Default"))
614 rr->explain_buf = "<explain>\n"
616 "\t\t<host>localhost</host>\n"
617 "\t\t<port>210</port>\n"
624 bend_initresult *bend_init(bend_initrequest *q)
626 bend_initresult *r = (bend_initresult *)
627 odr_malloc (q->stream, sizeof(*r));
628 int *counter = (int *) xmalloc (sizeof(int));
633 r->handle = counter; /* user handle, in this case a simple int */
634 q->bend_sort = ztest_sort; /* register sort handler */
635 q->bend_search = ztest_search; /* register search handler */
636 q->bend_present = ztest_present; /* register present handle */
637 q->bend_esrequest = ztest_esrequest;
638 q->bend_delete = ztest_delete;
639 q->bend_fetch = ztest_fetch;
640 q->bend_scan = ztest_scan;
641 q->bend_explain = ztest_explain;
645 void bend_close(void *handle)
647 xfree (handle); /* release our user-defined handle */
651 int main(int argc, char **argv)
653 return statserv_main(argc, argv, bend_init, bend_close);