2 * Copyright (c) 1995-2004, Index Data.
3 * See the file LICENSE for details.
5 * $Id: ztest.c,v 1.64 2004-05-10 10:46:42 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)
38 /* if database is stop, stop this process.. For debugging only. */
39 if (!yaz_matchstr (rr->basenames[0], "stop"))
41 nmem_print_list_l(LOG_LOG);
45 /* Throw Database unavailable if other than Default */
46 if (yaz_matchstr (rr->basenames[0], "Default"))
49 rr->errstring = rr->basenames[0];
52 rr->hits = rand() % 24;
57 /* this huge function handles extended services */
58 int ztest_esrequest (void *handle, bend_esrequest_rr *rr)
60 /* user-defined handle - created in bend_init */
61 int *counter = (int*) handle;
63 yaz_log(LOG_LOG, "ESRequest no %d", *counter);
67 if (rr->esr->packageName)
68 yaz_log(LOG_LOG, "packagename: %s", rr->esr->packageName);
69 yaz_log(LOG_LOG, "Waitaction: %d", *rr->esr->waitAction);
72 yaz_log(LOG_LOG, "function: %d", *rr->esr->function);
74 if (!rr->esr->taskSpecificParameters)
76 yaz_log (LOG_WARN, "No task specific parameters");
78 else if (rr->esr->taskSpecificParameters->which == Z_External_itemOrder)
80 Z_ItemOrder *it = rr->esr->taskSpecificParameters->u.itemOrder;
81 yaz_log (LOG_LOG, "Received ItemOrder");
82 if (it->which == Z_IOItemOrder_esRequest)
84 Z_IORequest *ir = it->u.esRequest;
85 Z_IOOriginPartToKeep *k = ir->toKeep;
86 Z_IOOriginPartNotToKeep *n = ir->notToKeep;
91 yaz_log(LOG_LOG, "contact name %s", k->contact->name);
92 if (k->contact->phone)
93 yaz_log(LOG_LOG, "contact phone %s", k->contact->phone);
94 if (k->contact->email)
95 yaz_log(LOG_LOG, "contact email %s", k->contact->email);
99 yaz_log(LOG_LOG, "Billing info (not shown)");
102 if (n->resultSetItem)
104 yaz_log(LOG_LOG, "resultsetItem");
105 yaz_log(LOG_LOG, "setId: %s", n->resultSetItem->resultSetId);
106 yaz_log(LOG_LOG, "item: %d", *n->resultSetItem->item);
110 Z_External *r = (Z_External*) n->itemRequest;
111 ILL_ItemRequest *item_req = 0;
112 ILL_APDU *ill_apdu = 0;
113 if (r->direct_reference)
115 oident *ent = oid_getentbyoid(r->direct_reference);
117 yaz_log(LOG_LOG, "OID %s", ent->desc);
118 if (ent && ent->value == VAL_TEXT_XML)
120 yaz_log (LOG_LOG, "ILL XML request");
121 if (r->which == Z_External_octet)
122 yaz_log (LOG_LOG, "%.*s", r->u.octet_aligned->len,
123 r->u.octet_aligned->buf);
125 if (ent && ent->value == VAL_ISO_ILL_1)
127 yaz_log (LOG_LOG, "Decode ItemRequest begin");
128 if (r->which == ODR_EXTERNAL_single)
130 odr_setbuf(rr->decode,
131 (char *) r->u.single_ASN1_type->buf,
132 r->u.single_ASN1_type->len, 0);
134 if (!ill_ItemRequest (rr->decode, &item_req, 0, 0))
137 "Couldn't decode ItemRequest %s near %d",
138 odr_errmsg(odr_geterror(rr->decode)),
139 odr_offset(rr->decode));
142 yaz_log(LOG_LOG, "Decode ItemRequest OK");
145 ill_ItemRequest (rr->print, &item_req, 0,
147 odr_reset (rr->print);
150 if (!item_req && r->which == ODR_EXTERNAL_single)
152 yaz_log (LOG_LOG, "Decode ILL APDU begin");
153 odr_setbuf(rr->decode,
154 (char*) r->u.single_ASN1_type->buf,
155 r->u.single_ASN1_type->len, 0);
157 if (!ill_APDU (rr->decode, &ill_apdu, 0, 0))
160 "Couldn't decode ILL APDU %s near %d",
161 odr_errmsg(odr_geterror(rr->decode)),
162 odr_offset(rr->decode));
163 yaz_log(LOG_LOG, "PDU dump:");
164 odr_dumpBER(yaz_log_file(),
165 (char *) r->u.single_ASN1_type->buf,
166 r->u.single_ASN1_type->len);
169 yaz_log(LOG_LOG, "Decode ILL APDU OK");
172 ill_APDU (rr->print, &ill_apdu, 0,
174 odr_reset (rr->print);
181 yaz_log (LOG_LOG, "ILL protocol version = %d",
182 *item_req->protocol_version_num);
188 Z_External *ext = (Z_External *)
189 odr_malloc (rr->stream, sizeof(*ext));
190 Z_IUOriginPartToKeep *keep = (Z_IUOriginPartToKeep *)
191 odr_malloc (rr->stream, sizeof(*keep));
192 Z_IOTargetPart *targetPart = (Z_IOTargetPart *)
193 odr_malloc (rr->stream, sizeof(*targetPart));
195 rr->taskPackage = (Z_TaskPackage *)
196 odr_malloc (rr->stream, sizeof(*rr->taskPackage));
197 rr->taskPackage->packageType =
198 odr_oiddup (rr->stream, rr->esr->packageType);
199 rr->taskPackage->packageName = 0;
200 rr->taskPackage->userId = 0;
201 rr->taskPackage->retentionTime = 0;
202 rr->taskPackage->permissions = 0;
203 rr->taskPackage->description = 0;
204 rr->taskPackage->targetReference = (Odr_oct *)
205 odr_malloc (rr->stream, sizeof(Odr_oct));
206 rr->taskPackage->targetReference->buf =
207 (unsigned char *) odr_strdup (rr->stream, "911");
208 rr->taskPackage->targetReference->len =
209 rr->taskPackage->targetReference->size =
210 strlen((char *) (rr->taskPackage->targetReference->buf));
211 rr->taskPackage->creationDateTime = 0;
212 rr->taskPackage->taskStatus = odr_intdup(rr->stream, 0);
213 rr->taskPackage->packageDiagnostics = 0;
214 rr->taskPackage->taskSpecificParameters = ext;
216 ext->direct_reference =
217 odr_oiddup (rr->stream, rr->esr->packageType);
218 ext->indirect_reference = 0;
220 ext->which = Z_External_itemOrder;
221 ext->u.itemOrder = (Z_ItemOrder *)
222 odr_malloc (rr->stream, sizeof(*ext->u.update));
223 ext->u.itemOrder->which = Z_IOItemOrder_taskPackage;
224 ext->u.itemOrder->u.taskPackage = (Z_IOTaskPackage *)
225 odr_malloc (rr->stream, sizeof(Z_IOTaskPackage));
226 ext->u.itemOrder->u.taskPackage->originPart = k;
227 ext->u.itemOrder->u.taskPackage->targetPart = targetPart;
229 targetPart->itemRequest = 0;
230 targetPart->statusOrErrorReport = 0;
231 targetPart->auxiliaryStatus = 0;
235 else if (rr->esr->taskSpecificParameters->which == Z_External_update)
237 Z_IUUpdate *up = rr->esr->taskSpecificParameters->u.update;
238 yaz_log (LOG_LOG, "Received DB Update");
239 if (up->which == Z_IUUpdate_esRequest)
241 Z_IUUpdateEsRequest *esRequest = up->u.esRequest;
242 Z_IUOriginPartToKeep *toKeep = esRequest->toKeep;
243 Z_IUSuppliedRecords *notToKeep = esRequest->notToKeep;
245 yaz_log (LOG_LOG, "action");
248 switch (*toKeep->action)
250 case Z_IUOriginPartToKeep_recordInsert:
251 yaz_log (LOG_LOG, " recordInsert");
253 case Z_IUOriginPartToKeep_recordReplace:
254 yaz_log (LOG_LOG, " recordReplace");
256 case Z_IUOriginPartToKeep_recordDelete:
257 yaz_log (LOG_LOG, " recordDelete");
259 case Z_IUOriginPartToKeep_elementUpdate:
260 yaz_log (LOG_LOG, " elementUpdate");
262 case Z_IUOriginPartToKeep_specialUpdate:
263 yaz_log (LOG_LOG, " specialUpdate");
266 yaz_log (LOG_LOG, " unknown (%d)", *toKeep->action);
269 if (toKeep->databaseName)
271 yaz_log (LOG_LOG, "database: %s", toKeep->databaseName);
272 if (!strcmp(toKeep->databaseName, "fault"))
275 rr->errstring = toKeep->databaseName;
277 if (!strcmp(toKeep->databaseName, "accept"))
282 Z_External *ext = (Z_External *)
283 odr_malloc (rr->stream, sizeof(*ext));
284 Z_IUOriginPartToKeep *keep = (Z_IUOriginPartToKeep *)
285 odr_malloc (rr->stream, sizeof(*keep));
286 Z_IUTargetPart *targetPart = (Z_IUTargetPart *)
287 odr_malloc (rr->stream, sizeof(*targetPart));
289 rr->taskPackage = (Z_TaskPackage *)
290 odr_malloc (rr->stream, sizeof(*rr->taskPackage));
291 rr->taskPackage->packageType =
292 odr_oiddup (rr->stream, rr->esr->packageType);
293 rr->taskPackage->packageName = 0;
294 rr->taskPackage->userId = 0;
295 rr->taskPackage->retentionTime = 0;
296 rr->taskPackage->permissions = 0;
297 rr->taskPackage->description = 0;
298 rr->taskPackage->targetReference = (Odr_oct *)
299 odr_malloc (rr->stream, sizeof(Odr_oct));
300 rr->taskPackage->targetReference->buf =
301 (unsigned char *) odr_strdup (rr->stream, "123");
302 rr->taskPackage->targetReference->len =
303 rr->taskPackage->targetReference->size =
304 strlen((char *) (rr->taskPackage->targetReference->buf));
305 rr->taskPackage->creationDateTime = 0;
306 rr->taskPackage->taskStatus = odr_intdup(rr->stream, 0);
307 rr->taskPackage->packageDiagnostics = 0;
308 rr->taskPackage->taskSpecificParameters = ext;
310 ext->direct_reference =
311 odr_oiddup (rr->stream, rr->esr->packageType);
312 ext->indirect_reference = 0;
314 ext->which = Z_External_update;
315 ext->u.update = (Z_IUUpdate *)
316 odr_malloc (rr->stream, sizeof(*ext->u.update));
317 ext->u.update->which = Z_IUUpdate_taskPackage;
318 ext->u.update->u.taskPackage = (Z_IUUpdateTaskPackage *)
319 odr_malloc (rr->stream, sizeof(Z_IUUpdateTaskPackage));
320 ext->u.update->u.taskPackage->originPart = keep;
321 ext->u.update->u.taskPackage->targetPart = targetPart;
323 keep->action = (int *) odr_malloc (rr->stream, sizeof(int));
324 *keep->action = *toKeep->action;
326 odr_strdup (rr->stream, toKeep->databaseName);
328 keep->elementSetName = 0;
329 keep->actionQualifier = 0;
331 targetPart->updateStatus = odr_intdup (rr->stream, 1);
332 targetPart->num_globalDiagnostics = 0;
333 targetPart->globalDiagnostics = (Z_DiagRec **) odr_nullval();
334 targetPart->num_taskPackageRecords = 1;
335 targetPart->taskPackageRecords =
336 (Z_IUTaskPackageRecordStructure **)
337 odr_malloc (rr->stream,
338 sizeof(Z_IUTaskPackageRecordStructure *));
339 targetPart->taskPackageRecords[0] =
340 (Z_IUTaskPackageRecordStructure *)
341 odr_malloc (rr->stream,
342 sizeof(Z_IUTaskPackageRecordStructure));
344 targetPart->taskPackageRecords[0]->which =
345 Z_IUTaskPackageRecordStructure_record;
346 targetPart->taskPackageRecords[0]->u.record =
347 z_ext_record (rr->stream, VAL_SUTRS, "test", 4);
348 targetPart->taskPackageRecords[0]->correlationInfo = 0;
349 targetPart->taskPackageRecords[0]->recordStatus =
350 odr_intdup (rr->stream,
351 Z_IUTaskPackageRecordStructure_success);
352 targetPart->taskPackageRecords[0]->num_supplementalDiagnostics
355 targetPart->taskPackageRecords[0]->supplementalDiagnostics = 0;
360 for (i = 0; i < notToKeep->num; i++)
362 Z_External *rec = notToKeep->elements[i]->record;
364 if (rec->direct_reference)
366 struct oident *oident;
367 oident = oid_getentbyoid(rec->direct_reference);
369 yaz_log (LOG_LOG, "record %d type %s", i,
374 case Z_External_sutrs:
375 if (rec->u.octet_aligned->len > 170)
376 yaz_log (LOG_LOG, "%d bytes:\n%.168s ...",
380 yaz_log (LOG_LOG, "%d bytes:\n%s",
384 case Z_External_octet :
385 if (rec->u.octet_aligned->len > 170)
386 yaz_log (LOG_LOG, "%d bytes:\n%.168s ...",
387 rec->u.octet_aligned->len,
388 rec->u.octet_aligned->buf);
390 yaz_log (LOG_LOG, "%d bytes\n%s",
391 rec->u.octet_aligned->len,
392 rec->u.octet_aligned->buf);
398 else if (rr->esr->taskSpecificParameters->which == Z_External_update0)
400 yaz_log(LOG_LOG, "Received DB Update (version 0)");
404 yaz_log (LOG_WARN, "Unknown Extended Service(%d)",
405 rr->esr->taskSpecificParameters->which);
411 /* result set delete */
412 int ztest_delete (void *handle, bend_delete_rr *rr)
414 if (rr->num_setnames == 1 && !strcmp (rr->setnames[0], "1"))
415 rr->delete_status = Z_DeleteStatus_success;
417 rr->delete_status = Z_DeleteStatus_resultSetDidNotExist;
421 /* Our sort handler really doesn't sort... */
422 int ztest_sort (void *handle, bend_sort_rr *rr)
425 rr->sort_status = Z_SortResponse_success;
430 /* present request handler */
431 int ztest_present (void *handle, bend_present_rr *rr)
436 /* retrieval of a single record (present, and piggy back search) */
437 int ztest_fetch(void *handle, bend_fetch_rr *r)
442 r->basename = "Default";
443 r->output_format = r->request_format;
444 if (r->request_format == VAL_SUTRS)
446 /* this section returns a small record */
449 sprintf(buf, "This is dummy SUTRS record number %d\n", r->number);
451 r->len = strlen(buf);
452 r->record = (char *) odr_malloc (r->stream, r->len+1);
453 strcpy(r->record, buf);
455 else if (r->request_format == VAL_GRS1)
458 r->record = (char*) dummy_grs_record(r->number, r->stream);
465 else if (r->request_format == VAL_POSTSCRIPT)
471 sprintf (fname, "part.%d.ps", r->number);
472 f = fopen(fname, "rb");
478 fseek (f, 0L, SEEK_END);
480 if (size <= 0 || size >= 5000000)
485 fseek (f, 0L, SEEK_SET);
486 r->record = (char*) odr_malloc (r->stream, size);
488 r->output_format = VAL_POSTSCRIPT;
489 fread (r->record, size, 1, f);
492 else if (r->request_format == VAL_TEXT_XML &&
493 (cp = dummy_xml_record (r->number, r->stream)))
497 r->output_format = VAL_TEXT_XML;
499 else if ((cp = dummy_marc_record(r->number, r->stream)))
503 r->output_format = VAL_USMARC;
515 * silly dummy-scan what reads words from a file.
517 int ztest_scan(void *handle, bend_scan_rr *q)
520 static struct scan_entry list[200];
521 static char entries[200][80];
525 int term_position_req = q->term_position;
526 int num_entries_req = q->num_entries;
531 q->status = BEND_SCAN_SUCCESS;
532 if (!f && !(f = fopen("dummy-words", "r")))
534 perror("dummy-words");
537 if (q->term->term->which != Z_Term_general)
539 q->errcode = 229; /* unsupported term type */
542 if (*q->step_size != 0)
544 q->errcode = 205; /*Only zero step size supported for Scan */
547 if (q->term->term->u.general->len >= 80)
549 q->errcode = 11; /* term too long */
552 if (q->num_entries > 200)
557 memcpy(term, q->term->term->u.general->buf, q->term->term->u.general->len);
558 term[q->term->term->u.general->len] = '\0';
559 for (p = term; *p; p++)
563 fseek(f, 0, SEEK_SET);
566 for (i = 0, pos = 0; fscanf(f, " %79[^:]:%d", entries[pos], &hits[pos]) == 2;
567 i++, pos < 199 ? pos++ : (pos = 0))
569 if (!q->num_entries && strcmp(entries[pos], term) >= 0) /* s-point fnd */
571 if ((q->term_position = term_position_req) > i + 1)
573 q->term_position = i + 1;
574 q->status = BEND_SCAN_PARTIAL;
576 for (; q->num_entries < q->term_position; q->num_entries++)
580 po = pos - q->term_position + q->num_entries+1; /* find pos */
584 if (!strcmp (term, "SD") && q->num_entries == 2)
586 list[q->num_entries].term = entries[pos];
587 list[q->num_entries].occurrences = -1;
588 list[q->num_entries].errcode = 233;
589 list[q->num_entries].errstring = "SD for Scan Term";
593 list[q->num_entries].term = entries[po];
594 list[q->num_entries].occurrences = hits[po];
598 else if (q->num_entries)
600 list[q->num_entries].term = entries[pos];
601 list[q->num_entries].occurrences = hits[pos];
604 if (q->num_entries >= num_entries_req)
608 q->status = BEND_SCAN_PARTIAL;
612 static int ztest_explain(void *handle, bend_explain_rr *rr)
614 if (rr->database && !strcmp(rr->database, "Default"))
616 rr->explain_buf = "<explain>\n"
618 "\t\t<host>localhost</host>\n"
619 "\t\t<port>210</port>\n"
626 bend_initresult *bend_init(bend_initrequest *q)
628 bend_initresult *r = (bend_initresult *)
629 odr_malloc (q->stream, sizeof(*r));
630 int *counter = (int *) xmalloc (sizeof(int));
635 r->handle = counter; /* user handle, in this case a simple int */
636 q->bend_sort = ztest_sort; /* register sort handler */
637 q->bend_search = ztest_search; /* register search handler */
638 q->bend_present = ztest_present; /* register present handle */
639 q->bend_esrequest = ztest_esrequest;
640 q->bend_delete = ztest_delete;
641 q->bend_fetch = ztest_fetch;
642 q->bend_scan = ztest_scan;
643 q->bend_explain = ztest_explain;
648 void bend_close(void *handle)
650 xfree (handle); /* release our user-defined handle */
654 int main(int argc, char **argv)
656 return statserv_main(argc, argv, bend_init, bend_close);