2 * Copyright (C) 1995-2005, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: ztest.c,v 1.76 2006-01-17 19:04:05 adam Exp $
9 * Demonstration of simple server
19 #include <yaz/yaz-util.h>
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"))
64 rr->errstring = rr->basenames[0];
67 rr->hits = rand() % 24;
72 /* this huge function handles extended services */
73 int ztest_esrequest (void *handle, bend_esrequest_rr *rr)
75 /* user-defined handle - created in bend_init */
76 int *counter = (int*) handle;
78 yaz_log(log_level, "ESRequest no %d", *counter);
82 if (rr->esr->packageName)
83 yaz_log(log_level, "packagename: %s", rr->esr->packageName);
84 yaz_log(log_level, "Waitaction: %d", *rr->esr->waitAction);
87 yaz_log(log_level, "function: %d", *rr->esr->function);
89 if (!rr->esr->taskSpecificParameters)
91 yaz_log (log_level, "No task specific parameters");
93 else if (rr->esr->taskSpecificParameters->which == Z_External_itemOrder)
95 Z_ItemOrder *it = rr->esr->taskSpecificParameters->u.itemOrder;
96 yaz_log (log_level, "Received ItemOrder");
97 if (it->which == Z_IOItemOrder_esRequest)
99 Z_IORequest *ir = it->u.esRequest;
100 Z_IOOriginPartToKeep *k = ir->toKeep;
101 Z_IOOriginPartNotToKeep *n = ir->notToKeep;
105 if (k->contact->name)
106 yaz_log(log_level, "contact name %s", k->contact->name);
107 if (k->contact->phone)
108 yaz_log(log_level, "contact phone %s", k->contact->phone);
109 if (k->contact->email)
110 yaz_log(log_level, "contact email %s", k->contact->email);
114 yaz_log(log_level, "Billing info (not shown)");
117 if (n->resultSetItem)
119 yaz_log(log_level, "resultsetItem");
120 yaz_log(log_level, "setId: %s", n->resultSetItem->resultSetId);
121 yaz_log(log_level, "item: %d", *n->resultSetItem->item);
125 Z_External *r = (Z_External*) n->itemRequest;
126 ILL_ItemRequest *item_req = 0;
127 ILL_APDU *ill_apdu = 0;
128 if (r->direct_reference)
130 oident *ent = oid_getentbyoid(r->direct_reference);
132 yaz_log(log_level, "OID %s", ent->desc);
133 if (ent && ent->value == VAL_TEXT_XML)
135 yaz_log (log_level, "ILL XML request");
136 if (r->which == Z_External_octet)
137 yaz_log (log_level, "%.*s", r->u.octet_aligned->len,
138 r->u.octet_aligned->buf);
140 if (ent && ent->value == VAL_ISO_ILL_1)
142 yaz_log (log_level, "Decode ItemRequest begin");
143 if (r->which == ODR_EXTERNAL_single)
145 odr_setbuf(rr->decode,
146 (char *) r->u.single_ASN1_type->buf,
147 r->u.single_ASN1_type->len, 0);
149 if (!ill_ItemRequest (rr->decode, &item_req, 0, 0))
152 "Couldn't decode ItemRequest %s near %d",
153 odr_errmsg(odr_geterror(rr->decode)),
154 odr_offset(rr->decode));
157 yaz_log(log_level, "Decode ItemRequest OK");
160 ill_ItemRequest (rr->print, &item_req, 0,
162 odr_reset (rr->print);
165 if (!item_req && r->which == ODR_EXTERNAL_single)
167 yaz_log (log_level, "Decode ILL APDU begin");
168 odr_setbuf(rr->decode,
169 (char*) r->u.single_ASN1_type->buf,
170 r->u.single_ASN1_type->len, 0);
172 if (!ill_APDU (rr->decode, &ill_apdu, 0, 0))
175 "Couldn't decode ILL APDU %s near %d",
176 odr_errmsg(odr_geterror(rr->decode)),
177 odr_offset(rr->decode));
178 yaz_log(log_level, "PDU dump:");
179 odr_dumpBER(yaz_log_file(),
180 (char *) r->u.single_ASN1_type->buf,
181 r->u.single_ASN1_type->len);
184 yaz_log(log_level, "Decode ILL APDU OK");
187 ill_APDU (rr->print, &ill_apdu, 0,
189 odr_reset (rr->print);
196 yaz_log (log_level, "ILL protocol version = %d",
197 *item_req->protocol_version_num);
203 Z_External *ext = (Z_External *)
204 odr_malloc (rr->stream, sizeof(*ext));
205 Z_IUOriginPartToKeep *keep = (Z_IUOriginPartToKeep *)
206 odr_malloc (rr->stream, sizeof(*keep));
207 Z_IOTargetPart *targetPart = (Z_IOTargetPart *)
208 odr_malloc (rr->stream, sizeof(*targetPart));
210 rr->taskPackage = (Z_TaskPackage *)
211 odr_malloc (rr->stream, sizeof(*rr->taskPackage));
212 rr->taskPackage->packageType =
213 odr_oiddup (rr->stream, rr->esr->packageType);
214 rr->taskPackage->packageName = 0;
215 rr->taskPackage->userId = 0;
216 rr->taskPackage->retentionTime = 0;
217 rr->taskPackage->permissions = 0;
218 rr->taskPackage->description = 0;
219 rr->taskPackage->targetReference = (Odr_oct *)
220 odr_malloc (rr->stream, sizeof(Odr_oct));
221 rr->taskPackage->targetReference->buf =
222 (unsigned char *) odr_strdup (rr->stream, "911");
223 rr->taskPackage->targetReference->len =
224 rr->taskPackage->targetReference->size =
225 strlen((char *) (rr->taskPackage->targetReference->buf));
226 rr->taskPackage->creationDateTime = 0;
227 rr->taskPackage->taskStatus = odr_intdup(rr->stream, 0);
228 rr->taskPackage->packageDiagnostics = 0;
229 rr->taskPackage->taskSpecificParameters = ext;
231 ext->direct_reference =
232 odr_oiddup (rr->stream, rr->esr->packageType);
233 ext->indirect_reference = 0;
235 ext->which = Z_External_itemOrder;
236 ext->u.itemOrder = (Z_ItemOrder *)
237 odr_malloc (rr->stream, sizeof(*ext->u.update));
238 ext->u.itemOrder->which = Z_IOItemOrder_taskPackage;
239 ext->u.itemOrder->u.taskPackage = (Z_IOTaskPackage *)
240 odr_malloc (rr->stream, sizeof(Z_IOTaskPackage));
241 ext->u.itemOrder->u.taskPackage->originPart = k;
242 ext->u.itemOrder->u.taskPackage->targetPart = targetPart;
244 targetPart->itemRequest = 0;
245 targetPart->statusOrErrorReport = 0;
246 targetPart->auxiliaryStatus = 0;
250 else if (rr->esr->taskSpecificParameters->which == Z_External_update)
252 Z_IUUpdate *up = rr->esr->taskSpecificParameters->u.update;
253 yaz_log (log_level, "Received DB Update");
254 if (up->which == Z_IUUpdate_esRequest)
256 Z_IUUpdateEsRequest *esRequest = up->u.esRequest;
257 Z_IUOriginPartToKeep *toKeep = esRequest->toKeep;
258 Z_IUSuppliedRecords *notToKeep = esRequest->notToKeep;
260 yaz_log (log_level, "action");
263 switch (*toKeep->action)
265 case Z_IUOriginPartToKeep_recordInsert:
266 yaz_log (log_level, " recordInsert");
268 case Z_IUOriginPartToKeep_recordReplace:
269 yaz_log (log_level, " recordReplace");
271 case Z_IUOriginPartToKeep_recordDelete:
272 yaz_log (log_level, " recordDelete");
274 case Z_IUOriginPartToKeep_elementUpdate:
275 yaz_log (log_level, " elementUpdate");
277 case Z_IUOriginPartToKeep_specialUpdate:
278 yaz_log (log_level, " specialUpdate");
281 yaz_log (log_level, " unknown (%d)", *toKeep->action);
284 if (toKeep->databaseName)
286 yaz_log (log_level, "database: %s", toKeep->databaseName);
287 if (!strcmp(toKeep->databaseName, "fault"))
290 rr->errstring = toKeep->databaseName;
292 if (!strcmp(toKeep->databaseName, "accept"))
297 Z_External *ext = (Z_External *)
298 odr_malloc (rr->stream, sizeof(*ext));
299 Z_IUOriginPartToKeep *keep = (Z_IUOriginPartToKeep *)
300 odr_malloc (rr->stream, sizeof(*keep));
301 Z_IUTargetPart *targetPart = (Z_IUTargetPart *)
302 odr_malloc (rr->stream, sizeof(*targetPart));
304 rr->taskPackage = (Z_TaskPackage *)
305 odr_malloc (rr->stream, sizeof(*rr->taskPackage));
306 rr->taskPackage->packageType =
307 odr_oiddup (rr->stream, rr->esr->packageType);
308 rr->taskPackage->packageName = 0;
309 rr->taskPackage->userId = 0;
310 rr->taskPackage->retentionTime = 0;
311 rr->taskPackage->permissions = 0;
312 rr->taskPackage->description = 0;
313 rr->taskPackage->targetReference = (Odr_oct *)
314 odr_malloc (rr->stream, sizeof(Odr_oct));
315 rr->taskPackage->targetReference->buf =
316 (unsigned char *) odr_strdup (rr->stream, "123");
317 rr->taskPackage->targetReference->len =
318 rr->taskPackage->targetReference->size =
319 strlen((char *) (rr->taskPackage->targetReference->buf));
320 rr->taskPackage->creationDateTime = 0;
321 rr->taskPackage->taskStatus = odr_intdup(rr->stream, 0);
322 rr->taskPackage->packageDiagnostics = 0;
323 rr->taskPackage->taskSpecificParameters = ext;
325 ext->direct_reference =
326 odr_oiddup (rr->stream, rr->esr->packageType);
327 ext->indirect_reference = 0;
329 ext->which = Z_External_update;
330 ext->u.update = (Z_IUUpdate *)
331 odr_malloc (rr->stream, sizeof(*ext->u.update));
332 ext->u.update->which = Z_IUUpdate_taskPackage;
333 ext->u.update->u.taskPackage = (Z_IUUpdateTaskPackage *)
334 odr_malloc (rr->stream, sizeof(Z_IUUpdateTaskPackage));
335 ext->u.update->u.taskPackage->originPart = keep;
336 ext->u.update->u.taskPackage->targetPart = targetPart;
338 keep->action = (int *) odr_malloc (rr->stream, sizeof(int));
339 *keep->action = *toKeep->action;
341 odr_strdup (rr->stream, toKeep->databaseName);
343 keep->elementSetName = 0;
344 keep->actionQualifier = 0;
346 targetPart->updateStatus = odr_intdup (rr->stream, 1);
347 targetPart->num_globalDiagnostics = 0;
348 targetPart->globalDiagnostics = (Z_DiagRec **) odr_nullval();
349 targetPart->num_taskPackageRecords = 1;
350 targetPart->taskPackageRecords =
351 (Z_IUTaskPackageRecordStructure **)
352 odr_malloc (rr->stream,
353 sizeof(Z_IUTaskPackageRecordStructure *));
354 targetPart->taskPackageRecords[0] =
355 (Z_IUTaskPackageRecordStructure *)
356 odr_malloc (rr->stream,
357 sizeof(Z_IUTaskPackageRecordStructure));
359 targetPart->taskPackageRecords[0]->which =
360 Z_IUTaskPackageRecordStructure_record;
361 targetPart->taskPackageRecords[0]->u.record =
362 z_ext_record (rr->stream, VAL_SUTRS, "test", 4);
363 targetPart->taskPackageRecords[0]->correlationInfo = 0;
364 targetPart->taskPackageRecords[0]->recordStatus =
365 odr_intdup (rr->stream,
366 Z_IUTaskPackageRecordStructure_success);
367 targetPart->taskPackageRecords[0]->num_supplementalDiagnostics
370 targetPart->taskPackageRecords[0]->supplementalDiagnostics = 0;
375 for (i = 0; i < notToKeep->num; i++)
377 Z_External *rec = notToKeep->elements[i]->record;
379 if (rec->direct_reference)
381 struct oident *oident;
382 oident = oid_getentbyoid(rec->direct_reference);
384 yaz_log (log_level, "record %d type %s", i,
389 case Z_External_sutrs:
390 if (rec->u.octet_aligned->len > 170)
391 yaz_log (log_level, "%d bytes:\n%.168s ...",
395 yaz_log (log_level, "%d bytes:\n%s",
399 case Z_External_octet :
400 if (rec->u.octet_aligned->len > 170)
401 yaz_log (log_level, "%d bytes:\n%.168s ...",
402 rec->u.octet_aligned->len,
403 rec->u.octet_aligned->buf);
405 yaz_log (log_level, "%d bytes\n%s",
406 rec->u.octet_aligned->len,
407 rec->u.octet_aligned->buf);
413 else if (rr->esr->taskSpecificParameters->which == Z_External_update0)
415 yaz_log(log_level, "Received DB Update (version 0)");
419 yaz_log (YLOG_WARN, "Unknown Extended Service(%d)",
420 rr->esr->taskSpecificParameters->which);
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)
457 r->basename = "Default";
458 r->output_format = r->request_format;
459 if (r->request_format == VAL_SUTRS)
461 /* this section returns a small record */
464 sprintf(buf, "This is dummy SUTRS record number %d\n", r->number);
466 r->len = strlen(buf);
467 r->record = (char *) odr_malloc (r->stream, r->len+1);
468 strcpy(r->record, buf);
470 else if (r->request_format == VAL_GRS1)
473 r->record = (char*) dummy_grs_record(r->number, r->stream);
480 else if (r->request_format == VAL_POSTSCRIPT)
486 sprintf (fname, "part.%d.ps", r->number);
487 f = fopen(fname, "rb");
493 fseek (f, 0L, SEEK_END);
495 if (size <= 0 || size >= 5000000)
500 fseek (f, 0L, SEEK_SET);
501 r->record = (char*) odr_malloc (r->stream, size);
503 r->output_format = VAL_POSTSCRIPT;
504 fread (r->record, size, 1, f);
507 else if (r->request_format == VAL_TEXT_XML)
509 if ((cp = dummy_xml_record (r->number, r->stream)))
513 r->output_format = VAL_TEXT_XML;
518 r->surrogate_flag = 1;
522 else if ((cp = dummy_marc_record(r->number, r->stream)))
526 r->output_format = VAL_USMARC;
538 * silly dummy-scan what reads words from a file.
540 int ztest_scan(void *handle, bend_scan_rr *q)
543 static struct scan_entry list[200];
544 static char entries[200][80];
548 int term_position_req = q->term_position;
549 int num_entries_req = q->num_entries;
551 /* Throw Database unavailable if other than Default or Slow */
552 if (!yaz_matchstr (q->basenames[0], "Default"))
553 ; /* Default is OK in our test */
554 else if(!yaz_matchstr (q->basenames[0], "Slow"))
564 q->errstring = q->basenames[0];
571 q->status = BEND_SCAN_SUCCESS;
572 if (!f && !(f = fopen("dummy-words", "r")))
574 perror("dummy-words");
577 if (q->num_entries > 200)
585 if (q->term->term->which != Z_Term_general)
587 q->errcode = 229; /* unsupported term type */
590 if (*q->step_size != 0)
592 q->errcode = 205; /*Only zero step size supported for Scan */
595 len = q->term->term->u.general->len;
596 if (len >= sizeof(term))
597 len = sizeof(term)-1;
598 memcpy(term, q->term->term->u.general->buf, len);
601 else if (q->scanClause)
603 strncpy(term, q->scanClause, sizeof(term)-1);
604 term[sizeof(term)-1] = '\0';
609 for (p = term; *p; p++)
610 if (islower(*(unsigned char *) p))
613 fseek(f, 0, SEEK_SET);
616 for (i = 0, pos = 0; fscanf(f, " %79[^:]:%d", entries[pos], &hits[pos]) == 2;
617 i++, pos < 199 ? pos++ : (pos = 0))
619 if (!q->num_entries && strcmp(entries[pos], term) >= 0) /* s-point fnd */
621 if ((q->term_position = term_position_req) > i + 1)
623 q->term_position = i + 1;
624 q->status = BEND_SCAN_PARTIAL;
626 for (; q->num_entries < q->term_position; q->num_entries++)
630 po = pos - q->term_position + q->num_entries+1; /* find pos */
634 if (!strcmp (term, "SD") && q->num_entries == 2)
636 list[q->num_entries].term = entries[pos];
637 list[q->num_entries].occurrences = -1;
638 list[q->num_entries].errcode = 233;
639 list[q->num_entries].errstring = "SD for Scan Term";
643 list[q->num_entries].term = entries[po];
644 list[q->num_entries].occurrences = hits[po];
648 else if (q->num_entries)
650 list[q->num_entries].term = entries[pos];
651 list[q->num_entries].occurrences = hits[pos];
654 if (q->num_entries >= num_entries_req)
658 q->status = BEND_SCAN_PARTIAL;
662 static int ztest_explain(void *handle, bend_explain_rr *rr)
664 if (rr->database && !strcmp(rr->database, "Default"))
666 rr->explain_buf = "<explain>\n"
668 "\t\t<host>localhost</host>\n"
669 "\t\t<port>210</port>\n"
676 bend_initresult *bend_init(bend_initrequest *q)
678 bend_initresult *r = (bend_initresult *)
679 odr_malloc (q->stream, sizeof(*r));
680 int *counter = (int *) xmalloc (sizeof(int));
684 log_level=yaz_log_module_level("ztest");
691 r->handle = counter; /* user handle, in this case a simple int */
692 q->bend_sort = ztest_sort; /* register sort handler */
693 q->bend_search = ztest_search; /* register search handler */
694 q->bend_present = ztest_present; /* register present handle */
695 q->bend_esrequest = ztest_esrequest;
696 q->bend_delete = ztest_delete;
697 q->bend_fetch = ztest_fetch;
698 q->bend_scan = ztest_scan;
700 q->bend_explain = ztest_explain;
702 q->bend_srw_scan = ztest_scan;
707 void bend_close(void *handle)
709 xfree (handle); /* release our user-defined handle */
713 int main(int argc, char **argv)
715 return statserv_main(argc, argv, bend_init, bend_close);
720 * indent-tabs-mode: nil
722 * vim: shiftwidth=4 tabstop=8 expandtab