2 * Copyright (c) 1995-2003, Index Data.
3 * See the file LICENSE for details.
5 * $Id: ztest.c,v 1.58 2003-09-02 12:12:13 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 (yaz_matchstr (rr->basenames[0], "Default"))
40 rr->errstring = rr->basenames[0];
43 rr->hits = rand() % 24;
48 /* this huge function handles extended services */
49 int ztest_esrequest (void *handle, bend_esrequest_rr *rr)
51 /* user-defined handle - created in bend_init */
52 int *counter = (int*) handle;
54 yaz_log(LOG_LOG, "ESRequest no %d", *counter);
58 if (rr->esr->packageName)
59 yaz_log(LOG_LOG, "packagename: %s", rr->esr->packageName);
60 yaz_log(LOG_LOG, "Waitaction: %d", *rr->esr->waitAction);
63 yaz_log(LOG_LOG, "function: %d", *rr->esr->function);
65 if (!rr->esr->taskSpecificParameters)
67 yaz_log (LOG_WARN, "No task specific parameters");
69 else if (rr->esr->taskSpecificParameters->which == Z_External_itemOrder)
71 Z_ItemOrder *it = rr->esr->taskSpecificParameters->u.itemOrder;
72 yaz_log (LOG_LOG, "Received ItemOrder");
73 if (it->which == Z_IOItemOrder_esRequest)
75 Z_IORequest *ir = it->u.esRequest;
76 Z_IOOriginPartToKeep *k = ir->toKeep;
77 Z_IOOriginPartNotToKeep *n = ir->notToKeep;
82 yaz_log(LOG_LOG, "contact name %s", k->contact->name);
83 if (k->contact->phone)
84 yaz_log(LOG_LOG, "contact phone %s", k->contact->phone);
85 if (k->contact->email)
86 yaz_log(LOG_LOG, "contact email %s", k->contact->email);
90 yaz_log(LOG_LOG, "Billing info (not shown)");
95 yaz_log(LOG_LOG, "resultsetItem");
96 yaz_log(LOG_LOG, "setId: %s", n->resultSetItem->resultSetId);
97 yaz_log(LOG_LOG, "item: %d", *n->resultSetItem->item);
101 Z_External *r = (Z_External*) n->itemRequest;
102 ILL_ItemRequest *item_req = 0;
103 ILL_APDU *ill_apdu = 0;
104 if (r->direct_reference)
106 oident *ent = oid_getentbyoid(r->direct_reference);
108 yaz_log(LOG_LOG, "OID %s", ent->desc);
109 if (ent && ent->value == VAL_TEXT_XML)
111 yaz_log (LOG_LOG, "ILL XML request");
112 if (r->which == Z_External_octet)
113 yaz_log (LOG_LOG, "%.*s", r->u.octet_aligned->len,
114 r->u.octet_aligned->buf);
116 if (ent && ent->value == VAL_ISO_ILL_1)
118 yaz_log (LOG_LOG, "Decode ItemRequest begin");
119 if (r->which == ODR_EXTERNAL_single)
121 odr_setbuf(rr->decode,
122 (char *) r->u.single_ASN1_type->buf,
123 r->u.single_ASN1_type->len, 0);
125 if (!ill_ItemRequest (rr->decode, &item_req, 0, 0))
128 "Couldn't decode ItemRequest %s near %d",
129 odr_errmsg(odr_geterror(rr->decode)),
130 odr_offset(rr->decode));
133 yaz_log(LOG_LOG, "Decode ItemRequest OK");
136 ill_ItemRequest (rr->print, &item_req, 0,
138 odr_reset (rr->print);
141 if (!item_req && r->which == ODR_EXTERNAL_single)
143 yaz_log (LOG_LOG, "Decode ILL APDU begin");
144 odr_setbuf(rr->decode,
145 (char*) r->u.single_ASN1_type->buf,
146 r->u.single_ASN1_type->len, 0);
148 if (!ill_APDU (rr->decode, &ill_apdu, 0, 0))
151 "Couldn't decode ILL APDU %s near %d",
152 odr_errmsg(odr_geterror(rr->decode)),
153 odr_offset(rr->decode));
154 yaz_log(LOG_LOG, "PDU dump:");
155 odr_dumpBER(yaz_log_file(),
156 (char *) r->u.single_ASN1_type->buf,
157 r->u.single_ASN1_type->len);
160 yaz_log(LOG_LOG, "Decode ILL APDU OK");
163 ill_APDU (rr->print, &ill_apdu, 0,
165 odr_reset (rr->print);
172 yaz_log (LOG_LOG, "ILL protocol version = %d",
173 *item_req->protocol_version_num);
179 Z_External *ext = (Z_External *)
180 odr_malloc (rr->stream, sizeof(*ext));
181 Z_IUOriginPartToKeep *keep = (Z_IUOriginPartToKeep *)
182 odr_malloc (rr->stream, sizeof(*keep));
183 Z_IOTargetPart *targetPart = (Z_IOTargetPart *)
184 odr_malloc (rr->stream, sizeof(*targetPart));
186 rr->taskPackage = (Z_TaskPackage *)
187 odr_malloc (rr->stream, sizeof(*rr->taskPackage));
188 rr->taskPackage->packageType =
189 odr_oiddup (rr->stream, rr->esr->packageType);
190 rr->taskPackage->packageName = 0;
191 rr->taskPackage->userId = 0;
192 rr->taskPackage->retentionTime = 0;
193 rr->taskPackage->permissions = 0;
194 rr->taskPackage->description = 0;
195 rr->taskPackage->targetReference = (Odr_oct *)
196 odr_malloc (rr->stream, sizeof(Odr_oct));
197 rr->taskPackage->targetReference->buf =
198 (unsigned char *) odr_strdup (rr->stream, "911");
199 rr->taskPackage->targetReference->len =
200 rr->taskPackage->targetReference->size =
201 strlen((char *) (rr->taskPackage->targetReference->buf));
202 rr->taskPackage->creationDateTime = 0;
203 rr->taskPackage->taskStatus = odr_intdup(rr->stream, 0);
204 rr->taskPackage->packageDiagnostics = 0;
205 rr->taskPackage->taskSpecificParameters = ext;
207 ext->direct_reference =
208 odr_oiddup (rr->stream, rr->esr->packageType);
209 ext->indirect_reference = 0;
211 ext->which = Z_External_itemOrder;
212 ext->u.itemOrder = (Z_ItemOrder *)
213 odr_malloc (rr->stream, sizeof(*ext->u.update));
214 ext->u.itemOrder->which = Z_IOItemOrder_taskPackage;
215 ext->u.itemOrder->u.taskPackage = (Z_IOTaskPackage *)
216 odr_malloc (rr->stream, sizeof(Z_IOTaskPackage));
217 ext->u.itemOrder->u.taskPackage->originPart = k;
218 ext->u.itemOrder->u.taskPackage->targetPart = targetPart;
220 targetPart->itemRequest = 0;
221 targetPart->statusOrErrorReport = 0;
222 targetPart->auxiliaryStatus = 0;
226 else if (rr->esr->taskSpecificParameters->which == Z_External_update)
228 Z_IUUpdate *up = rr->esr->taskSpecificParameters->u.update;
229 yaz_log (LOG_LOG, "Received DB Update");
230 if (up->which == Z_IUUpdate_esRequest)
232 Z_IUUpdateEsRequest *esRequest = up->u.esRequest;
233 Z_IUOriginPartToKeep *toKeep = esRequest->toKeep;
234 Z_IUSuppliedRecords *notToKeep = esRequest->notToKeep;
236 yaz_log (LOG_LOG, "action");
239 switch (*toKeep->action)
241 case Z_IUOriginPartToKeep_recordInsert:
242 yaz_log (LOG_LOG, " recordInsert");
244 case Z_IUOriginPartToKeep_recordReplace:
245 yaz_log (LOG_LOG, " recordReplace");
247 case Z_IUOriginPartToKeep_recordDelete:
248 yaz_log (LOG_LOG, " recordDelete");
250 case Z_IUOriginPartToKeep_elementUpdate:
251 yaz_log (LOG_LOG, " elementUpdate");
253 case Z_IUOriginPartToKeep_specialUpdate:
254 yaz_log (LOG_LOG, " specialUpdate");
257 yaz_log (LOG_LOG, " unknown (%d)", *toKeep->action);
260 if (toKeep->databaseName)
262 yaz_log (LOG_LOG, "database: %s", toKeep->databaseName);
263 if (!strcmp(toKeep->databaseName, "fault"))
266 rr->errstring = toKeep->databaseName;
268 if (!strcmp(toKeep->databaseName, "accept"))
273 Z_External *ext = (Z_External *)
274 odr_malloc (rr->stream, sizeof(*ext));
275 Z_IUOriginPartToKeep *keep = (Z_IUOriginPartToKeep *)
276 odr_malloc (rr->stream, sizeof(*keep));
277 Z_IUTargetPart *targetPart = (Z_IUTargetPart *)
278 odr_malloc (rr->stream, sizeof(*targetPart));
280 rr->taskPackage = (Z_TaskPackage *)
281 odr_malloc (rr->stream, sizeof(*rr->taskPackage));
282 rr->taskPackage->packageType =
283 odr_oiddup (rr->stream, rr->esr->packageType);
284 rr->taskPackage->packageName = 0;
285 rr->taskPackage->userId = 0;
286 rr->taskPackage->retentionTime = 0;
287 rr->taskPackage->permissions = 0;
288 rr->taskPackage->description = 0;
289 rr->taskPackage->targetReference = (Odr_oct *)
290 odr_malloc (rr->stream, sizeof(Odr_oct));
291 rr->taskPackage->targetReference->buf =
292 (unsigned char *) odr_strdup (rr->stream, "123");
293 rr->taskPackage->targetReference->len =
294 rr->taskPackage->targetReference->size =
295 strlen((char *) (rr->taskPackage->targetReference->buf));
296 rr->taskPackage->creationDateTime = 0;
297 rr->taskPackage->taskStatus = odr_intdup(rr->stream, 0);
298 rr->taskPackage->packageDiagnostics = 0;
299 rr->taskPackage->taskSpecificParameters = ext;
301 ext->direct_reference =
302 odr_oiddup (rr->stream, rr->esr->packageType);
303 ext->indirect_reference = 0;
305 ext->which = Z_External_update;
306 ext->u.update = (Z_IUUpdate *)
307 odr_malloc (rr->stream, sizeof(*ext->u.update));
308 ext->u.update->which = Z_IUUpdate_taskPackage;
309 ext->u.update->u.taskPackage = (Z_IUUpdateTaskPackage *)
310 odr_malloc (rr->stream, sizeof(Z_IUUpdateTaskPackage));
311 ext->u.update->u.taskPackage->originPart = keep;
312 ext->u.update->u.taskPackage->targetPart = targetPart;
314 keep->action = (int *) odr_malloc (rr->stream, sizeof(int));
315 *keep->action = *toKeep->action;
317 odr_strdup (rr->stream, toKeep->databaseName);
319 keep->elementSetName = 0;
320 keep->actionQualifier = 0;
322 targetPart->updateStatus = odr_intdup (rr->stream, 1);
323 targetPart->num_globalDiagnostics = 0;
324 targetPart->globalDiagnostics = (Z_DiagRec **) odr_nullval();
325 targetPart->num_taskPackageRecords = 1;
326 targetPart->taskPackageRecords =
327 (Z_IUTaskPackageRecordStructure **)
328 odr_malloc (rr->stream,
329 sizeof(Z_IUTaskPackageRecordStructure *));
330 targetPart->taskPackageRecords[0] =
331 (Z_IUTaskPackageRecordStructure *)
332 odr_malloc (rr->stream,
333 sizeof(Z_IUTaskPackageRecordStructure));
335 targetPart->taskPackageRecords[0]->which =
336 Z_IUTaskPackageRecordStructure_record;
337 targetPart->taskPackageRecords[0]->u.record =
338 z_ext_record (rr->stream, VAL_SUTRS, "test", 4);
339 targetPart->taskPackageRecords[0]->correlationInfo = 0;
340 targetPart->taskPackageRecords[0]->recordStatus =
341 odr_intdup (rr->stream,
342 Z_IUTaskPackageRecordStructure_success);
343 targetPart->taskPackageRecords[0]->num_supplementalDiagnostics
346 targetPart->taskPackageRecords[0]->supplementalDiagnostics = 0;
351 for (i = 0; i < notToKeep->num; i++)
353 Z_External *rec = notToKeep->elements[i]->record;
355 if (rec->direct_reference)
357 struct oident *oident;
358 oident = oid_getentbyoid(rec->direct_reference);
360 yaz_log (LOG_LOG, "record %d type %s", i,
365 case Z_External_sutrs:
366 if (rec->u.octet_aligned->len > 170)
367 yaz_log (LOG_LOG, "%d bytes:\n%.168s ...",
371 yaz_log (LOG_LOG, "%d bytes:\n%s",
375 case Z_External_octet :
376 if (rec->u.octet_aligned->len > 170)
377 yaz_log (LOG_LOG, "%d bytes:\n%.168s ...",
378 rec->u.octet_aligned->len,
379 rec->u.octet_aligned->buf);
381 yaz_log (LOG_LOG, "%d bytes\n%s",
382 rec->u.octet_aligned->len,
383 rec->u.octet_aligned->buf);
389 else if (rr->esr->taskSpecificParameters->which == Z_External_update0)
391 yaz_log(LOG_LOG, "Received DB Update (version 0)");
395 yaz_log (LOG_WARN, "Unknown Extended Service(%d)",
396 rr->esr->taskSpecificParameters->which);
402 /* result set delete */
403 int ztest_delete (void *handle, bend_delete_rr *rr)
405 if (rr->num_setnames == 1 && !strcmp (rr->setnames[0], "1"))
406 rr->delete_status = Z_DeleteStatus_success;
408 rr->delete_status = Z_DeleteStatus_resultSetDidNotExist;
412 /* Our sort handler really doesn't sort... */
413 int ztest_sort (void *handle, bend_sort_rr *rr)
416 rr->sort_status = Z_SortStatus_success;
421 /* present request handler */
422 int ztest_present (void *handle, bend_present_rr *rr)
427 /* retrieval of a single record (present, and piggy back search) */
428 int ztest_fetch(void *handle, bend_fetch_rr *r)
433 r->basename = "Default";
434 r->output_format = r->request_format;
435 if (r->request_format == VAL_SUTRS)
437 /* this section returns a small record */
440 sprintf(buf, "This is dummy SUTRS record number %d\n", r->number);
442 r->len = strlen(buf);
443 r->record = (char *) odr_malloc (r->stream, r->len+1);
444 strcpy(r->record, buf);
446 else if (r->request_format == VAL_GRS1)
449 r->record = (char*) dummy_grs_record(r->number, r->stream);
456 else if (r->request_format == VAL_POSTSCRIPT)
462 sprintf (fname, "part.%d.ps", r->number);
463 f = fopen(fname, "rb");
469 fseek (f, 0L, SEEK_END);
471 if (size <= 0 || size >= 5000000)
476 fseek (f, 0L, SEEK_SET);
477 r->record = (char*) odr_malloc (r->stream, size);
479 r->output_format = VAL_POSTSCRIPT;
480 fread (r->record, size, 1, f);
483 else if (r->request_format == VAL_TEXT_XML &&
484 (cp = dummy_xml_record (r->number, r->stream)))
488 r->output_format = VAL_TEXT_XML;
490 else if ((cp = dummy_marc_record(r->number, r->stream)))
494 r->output_format = VAL_USMARC;
506 * silly dummy-scan what reads words from a file.
508 int ztest_scan(void *handle, bend_scan_rr *q)
511 static struct scan_entry list[200];
512 static char entries[200][80];
516 int term_position_req = q->term_position;
517 int num_entries_req = q->num_entries;
522 q->status = BEND_SCAN_SUCCESS;
523 if (!f && !(f = fopen("dummy-words", "r")))
525 perror("dummy-words");
528 if (q->term->term->which != Z_Term_general)
530 q->errcode = 229; /* unsupported term type */
533 if (*q->step_size != 0)
535 q->errcode = 205; /*Only zero step size supported for Scan */
538 if (q->term->term->u.general->len >= 80)
540 q->errcode = 11; /* term too long */
543 if (q->num_entries > 200)
548 memcpy(term, q->term->term->u.general->buf, q->term->term->u.general->len);
549 term[q->term->term->u.general->len] = '\0';
550 for (p = term; *p; p++)
554 fseek(f, 0, SEEK_SET);
557 for (i = 0, pos = 0; fscanf(f, " %79[^:]:%d", entries[pos], &hits[pos]) == 2;
558 i++, pos < 199 ? pos++ : (pos = 0))
560 if (!q->num_entries && strcmp(entries[pos], term) >= 0) /* s-point fnd */
562 if ((q->term_position = term_position_req) > i + 1)
564 q->term_position = i + 1;
565 q->status = BEND_SCAN_PARTIAL;
567 for (; q->num_entries < q->term_position; q->num_entries++)
571 po = pos - q->term_position + q->num_entries+1; /* find pos */
575 if (!strcmp (term, "SD") && q->num_entries == 2)
577 list[q->num_entries].term = entries[pos];
578 list[q->num_entries].occurrences = -1;
579 list[q->num_entries].errcode = 233;
580 list[q->num_entries].errstring = "SD for Scan Term";
584 list[q->num_entries].term = entries[po];
585 list[q->num_entries].occurrences = hits[po];
589 else if (q->num_entries)
591 list[q->num_entries].term = entries[pos];
592 list[q->num_entries].occurrences = hits[pos];
595 if (q->num_entries >= num_entries_req)
599 q->status = BEND_SCAN_PARTIAL;
603 static int ztest_explain(void *handle, bend_explain_rr *rr)
605 rr->explain_buf = "<explain>\n"
607 "\t\t<host>localhost</host>\n"
608 "\t\t<port>210</port>\n"
614 bend_initresult *bend_init(bend_initrequest *q)
616 bend_initresult *r = (bend_initresult *)
617 odr_malloc (q->stream, sizeof(*r));
618 int *counter = (int *) xmalloc (sizeof(int));
623 r->handle = counter; /* user handle, in this case a simple int */
624 q->bend_sort = ztest_sort; /* register sort handler */
625 q->bend_search = ztest_search; /* register search handler */
626 q->bend_present = ztest_present; /* register present handle */
627 q->bend_esrequest = ztest_esrequest;
628 q->bend_delete = ztest_delete;
629 q->bend_fetch = ztest_fetch;
630 q->bend_scan = ztest_scan;
631 q->bend_explain = ztest_explain;
635 void bend_close(void *handle)
637 xfree (handle); /* release our user-defined handle */
641 int main(int argc, char **argv)
643 return statserv_main(argc, argv, bend_init, bend_close);