1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2008 Index Data
3 * See the file LICENSE for details.
7 * Demonstration of simple server
18 #include <yaz/backend.h>
21 static int log_level=0;
22 static int log_level_set=0;
24 Z_GenericRecord *dummy_grs_record (int num, ODR o);
25 char *dummy_marc_record (int num, ODR odr);
26 char *dummy_xml_record (int num, ODR odr);
28 int ztest_search(void *handle, bend_search_rr *rr);
29 int ztest_sort(void *handle, bend_sort_rr *rr);
30 int ztest_present(void *handle, bend_present_rr *rr);
31 int ztest_esrequest(void *handle, bend_esrequest_rr *rr);
32 int ztest_delete(void *handle, bend_delete_rr *rr);
35 \brief use term value as hit count
37 Traverse RPN tree 'in order' and use term value as hit count.
38 Only terms that looks a numeric is used.. Returns -1 if
39 no sub tree has a hit count term
41 static int get_term_hit(Z_RPNStructure *s)
46 case Z_RPNStructure_simple:
47 if (s->u.simple->which == Z_Operand_APT)
49 Z_AttributesPlusTerm *apt = s->u.simple->u.attributesPlusTerm;
50 if (apt->term->which == Z_Term_general)
52 Odr_oct *oct = apt->term->u.general;
53 if (oct->len > 0 && oct->buf[0] >= '0' && oct->buf[0] <= '9')
54 h = atoi_n((const char *) oct->buf, oct->len);
58 case Z_RPNStructure_complex:
59 h = get_term_hit(s->u.complex->s1);
61 h = get_term_hit(s->u.complex->s2);
68 \brief gets hit count for numeric terms in RPN queries
70 This is just for testing.. A real database of course uses
71 the content of a database to establish a value.. In our case, we
72 have a way to trigger a certain hit count. Good for testing of
73 client applications etc
75 static int get_hit_count(Z_Query *q)
78 if (q->which == Z_Query_type_1 || q->which == Z_Query_type_101)
79 h = get_term_hit(q->u.type_1->RPNStructure);
85 int ztest_search(void *handle, bend_search_rr *rr)
87 if (rr->num_bases != 1)
92 /* Throw Database unavailable if other than Default or Slow */
93 if (!yaz_matchstr (rr->basenames[0], "Default"))
94 ; /* Default is OK in our test */
95 else if(!yaz_matchstr (rr->basenames[0], "Slow"))
98 /* wait up to 3 seconds and check if connection is still alive */
100 for (i = 0; i<3; i++)
102 if (!bend_assoc_is_alive(rr->association))
104 yaz_log(YLOG_LOG, "search aborted");
110 rr->estimated_hit_count = 1;
115 rr->errstring = rr->basenames[0];
119 rr->hits = get_hit_count(rr->query);
124 /* this huge function handles extended services */
125 int ztest_esrequest (void *handle, bend_esrequest_rr *rr)
127 /* user-defined handle - created in bend_init */
128 int *counter = (int*) handle;
130 yaz_log(log_level, "ESRequest no %d", *counter);
134 if (rr->esr->packageName)
135 yaz_log(log_level, "packagename: %s", rr->esr->packageName);
136 yaz_log(log_level, "Waitaction: %d", *rr->esr->waitAction);
139 yaz_log(log_level, "function: %d", *rr->esr->function);
141 if (!rr->esr->taskSpecificParameters)
143 yaz_log (log_level, "No task specific parameters");
145 else if (rr->esr->taskSpecificParameters->which == Z_External_itemOrder)
147 Z_ItemOrder *it = rr->esr->taskSpecificParameters->u.itemOrder;
148 yaz_log (log_level, "Received ItemOrder");
149 if (it->which == Z_IOItemOrder_esRequest)
151 Z_IORequest *ir = it->u.esRequest;
152 Z_IOOriginPartToKeep *k = ir->toKeep;
153 Z_IOOriginPartNotToKeep *n = ir->notToKeep;
154 const char *xml_in_response = 0;
158 if (k->contact->name)
159 yaz_log(log_level, "contact name %s", k->contact->name);
160 if (k->contact->phone)
161 yaz_log(log_level, "contact phone %s", k->contact->phone);
162 if (k->contact->email)
163 yaz_log(log_level, "contact email %s", k->contact->email);
167 yaz_log(log_level, "Billing info (not shown)");
170 if (n->resultSetItem)
172 yaz_log(log_level, "resultsetItem");
173 yaz_log(log_level, "setId: %s", n->resultSetItem->resultSetId);
174 yaz_log(log_level, "item: %d", *n->resultSetItem->item);
178 Z_External *r = (Z_External*) n->itemRequest;
179 ILL_ItemRequest *item_req = 0;
180 ILL_APDU *ill_apdu = 0;
181 if (r->direct_reference)
183 char oid_name_str[OID_STR_MAX];
185 const char *oid_name =
186 yaz_oid_to_string_buf(r->direct_reference,
187 &oclass, oid_name_str);
189 yaz_log(log_level, "OID %s", oid_name);
190 if (!oid_oidcmp(r->direct_reference, yaz_oid_recsyn_xml))
192 yaz_log (log_level, "ILL XML request");
193 if (r->which == Z_External_octet)
194 yaz_log (log_level, "%.*s",
195 r->u.octet_aligned->len,
196 r->u.octet_aligned->buf);
197 xml_in_response = "<dummy>x</dummy>";
199 if (!oid_oidcmp(r->direct_reference,
200 yaz_oid_general_isoill_1))
202 yaz_log (log_level, "Decode ItemRequest begin");
203 if (r->which == ODR_EXTERNAL_single)
205 odr_setbuf(rr->decode,
206 (char *) r->u.single_ASN1_type->buf,
207 r->u.single_ASN1_type->len, 0);
209 if (!ill_ItemRequest (rr->decode, &item_req, 0, 0))
212 "Couldn't decode ItemRequest %s near %ld",
213 odr_errmsg(odr_geterror(rr->decode)),
214 (long) odr_offset(rr->decode));
217 yaz_log(log_level, "Decode ItemRequest OK");
220 ill_ItemRequest (rr->print, &item_req, 0,
222 odr_reset (rr->print);
225 if (!item_req && r->which == ODR_EXTERNAL_single)
227 yaz_log (log_level, "Decode ILL APDU begin");
228 odr_setbuf(rr->decode,
229 (char*) r->u.single_ASN1_type->buf,
230 r->u.single_ASN1_type->len, 0);
232 if (!ill_APDU (rr->decode, &ill_apdu, 0, 0))
235 "Couldn't decode ILL APDU %s near %ld",
236 odr_errmsg(odr_geterror(rr->decode)),
237 (long) odr_offset(rr->decode));
238 yaz_log(log_level, "PDU dump:");
239 odr_dumpBER(yaz_log_file(),
240 (char *) r->u.single_ASN1_type->buf,
241 r->u.single_ASN1_type->len);
244 yaz_log(log_level, "Decode ILL APDU OK");
247 ill_APDU (rr->print, &ill_apdu, 0,
249 odr_reset (rr->print);
256 yaz_log (log_level, "ILL protocol version = %d",
257 *item_req->protocol_version_num);
263 Z_External *ext = (Z_External *)
264 odr_malloc (rr->stream, sizeof(*ext));
265 Z_IUOriginPartToKeep *keep = (Z_IUOriginPartToKeep *)
266 odr_malloc (rr->stream, sizeof(*keep));
267 Z_IOTargetPart *targetPart = (Z_IOTargetPart *)
268 odr_malloc (rr->stream, sizeof(*targetPart));
270 rr->taskPackage = (Z_TaskPackage *)
271 odr_malloc (rr->stream, sizeof(*rr->taskPackage));
272 rr->taskPackage->packageType =
273 odr_oiddup (rr->stream, rr->esr->packageType);
274 rr->taskPackage->packageName = 0;
275 rr->taskPackage->userId = 0;
276 rr->taskPackage->retentionTime = 0;
277 rr->taskPackage->permissions = 0;
278 rr->taskPackage->description = 0;
279 rr->taskPackage->targetReference = (Odr_oct *)
280 odr_malloc (rr->stream, sizeof(Odr_oct));
281 rr->taskPackage->targetReference->buf =
282 (unsigned char *) odr_strdup (rr->stream, "911");
283 rr->taskPackage->targetReference->len =
284 rr->taskPackage->targetReference->size =
285 strlen((char *) (rr->taskPackage->targetReference->buf));
286 rr->taskPackage->creationDateTime = 0;
287 rr->taskPackage->taskStatus = odr_intdup(rr->stream, 0);
288 rr->taskPackage->packageDiagnostics = 0;
289 rr->taskPackage->taskSpecificParameters = ext;
291 ext->direct_reference =
292 odr_oiddup (rr->stream, rr->esr->packageType);
293 ext->indirect_reference = 0;
295 ext->which = Z_External_itemOrder;
296 ext->u.itemOrder = (Z_ItemOrder *)
297 odr_malloc (rr->stream, sizeof(*ext->u.update));
298 ext->u.itemOrder->which = Z_IOItemOrder_taskPackage;
299 ext->u.itemOrder->u.taskPackage = (Z_IOTaskPackage *)
300 odr_malloc (rr->stream, sizeof(Z_IOTaskPackage));
301 ext->u.itemOrder->u.taskPackage->originPart = k;
302 ext->u.itemOrder->u.taskPackage->targetPart = targetPart;
305 targetPart->itemRequest =
306 z_ext_record_xml(rr->stream, xml_in_response,
307 strlen(xml_in_response));
309 targetPart->itemRequest = 0;
311 targetPart->statusOrErrorReport = 0;
312 targetPart->auxiliaryStatus = 0;
316 else if (rr->esr->taskSpecificParameters->which == Z_External_update)
318 Z_IUUpdate *up = rr->esr->taskSpecificParameters->u.update;
319 yaz_log (log_level, "Received DB Update");
320 if (up->which == Z_IUUpdate_esRequest)
322 Z_IUUpdateEsRequest *esRequest = up->u.esRequest;
323 Z_IUOriginPartToKeep *toKeep = esRequest->toKeep;
324 Z_IUSuppliedRecords *notToKeep = esRequest->notToKeep;
326 yaz_log (log_level, "action");
329 switch (*toKeep->action)
331 case Z_IUOriginPartToKeep_recordInsert:
332 yaz_log (log_level, " recordInsert");
334 case Z_IUOriginPartToKeep_recordReplace:
335 yaz_log (log_level, " recordReplace");
337 case Z_IUOriginPartToKeep_recordDelete:
338 yaz_log (log_level, " recordDelete");
340 case Z_IUOriginPartToKeep_elementUpdate:
341 yaz_log (log_level, " elementUpdate");
343 case Z_IUOriginPartToKeep_specialUpdate:
344 yaz_log (log_level, " specialUpdate");
347 yaz_log (log_level, " unknown (%d)", *toKeep->action);
350 if (toKeep->databaseName)
352 yaz_log (log_level, "database: %s", toKeep->databaseName);
353 if (!strcmp(toKeep->databaseName, "fault"))
356 rr->errstring = toKeep->databaseName;
358 if (!strcmp(toKeep->databaseName, "accept"))
363 Z_External *ext = (Z_External *)
364 odr_malloc (rr->stream, sizeof(*ext));
365 Z_IUOriginPartToKeep *keep = (Z_IUOriginPartToKeep *)
366 odr_malloc (rr->stream, sizeof(*keep));
367 Z_IUTargetPart *targetPart = (Z_IUTargetPart *)
368 odr_malloc (rr->stream, sizeof(*targetPart));
370 rr->taskPackage = (Z_TaskPackage *)
371 odr_malloc (rr->stream, sizeof(*rr->taskPackage));
372 rr->taskPackage->packageType =
373 odr_oiddup (rr->stream, rr->esr->packageType);
374 rr->taskPackage->packageName = 0;
375 rr->taskPackage->userId = 0;
376 rr->taskPackage->retentionTime = 0;
377 rr->taskPackage->permissions = 0;
378 rr->taskPackage->description = 0;
379 rr->taskPackage->targetReference = (Odr_oct *)
380 odr_malloc (rr->stream, sizeof(Odr_oct));
381 rr->taskPackage->targetReference->buf =
382 (unsigned char *) odr_strdup (rr->stream, "123");
383 rr->taskPackage->targetReference->len =
384 rr->taskPackage->targetReference->size =
385 strlen((char *) (rr->taskPackage->targetReference->buf));
386 rr->taskPackage->creationDateTime = 0;
387 rr->taskPackage->taskStatus = odr_intdup(rr->stream, 0);
388 rr->taskPackage->packageDiagnostics = 0;
389 rr->taskPackage->taskSpecificParameters = ext;
391 ext->direct_reference =
392 odr_oiddup (rr->stream, rr->esr->packageType);
393 ext->indirect_reference = 0;
395 ext->which = Z_External_update;
396 ext->u.update = (Z_IUUpdate *)
397 odr_malloc (rr->stream, sizeof(*ext->u.update));
398 ext->u.update->which = Z_IUUpdate_taskPackage;
399 ext->u.update->u.taskPackage = (Z_IUUpdateTaskPackage *)
400 odr_malloc (rr->stream, sizeof(Z_IUUpdateTaskPackage));
401 ext->u.update->u.taskPackage->originPart = keep;
402 ext->u.update->u.taskPackage->targetPart = targetPart;
404 keep->action = (int *) odr_malloc (rr->stream, sizeof(int));
405 *keep->action = *toKeep->action;
407 odr_strdup (rr->stream, toKeep->databaseName);
409 keep->elementSetName = 0;
410 keep->actionQualifier = 0;
412 targetPart->updateStatus = odr_intdup (rr->stream, 1);
413 targetPart->num_globalDiagnostics = 0;
414 targetPart->globalDiagnostics = (Z_DiagRec **) odr_nullval();
415 targetPart->num_taskPackageRecords = 1;
416 targetPart->taskPackageRecords =
417 (Z_IUTaskPackageRecordStructure **)
418 odr_malloc (rr->stream,
419 sizeof(Z_IUTaskPackageRecordStructure *));
420 targetPart->taskPackageRecords[0] =
421 (Z_IUTaskPackageRecordStructure *)
422 odr_malloc (rr->stream,
423 sizeof(Z_IUTaskPackageRecordStructure));
425 targetPart->taskPackageRecords[0]->which =
426 Z_IUTaskPackageRecordStructure_record;
427 targetPart->taskPackageRecords[0]->u.record =
428 z_ext_record_sutrs(rr->stream, "test", 4);
429 targetPart->taskPackageRecords[0]->correlationInfo = 0;
430 targetPart->taskPackageRecords[0]->recordStatus =
431 odr_intdup (rr->stream,
432 Z_IUTaskPackageRecordStructure_success);
433 targetPart->taskPackageRecords[0]->num_supplementalDiagnostics
436 targetPart->taskPackageRecords[0]->supplementalDiagnostics = 0;
441 for (i = 0; i < notToKeep->num; i++)
443 Z_External *rec = notToKeep->elements[i]->record;
445 if (rec->direct_reference)
447 char oid_name_str[OID_STR_MAX];
449 = oid_name = yaz_oid_to_string_buf(
450 rec->direct_reference, 0,
453 yaz_log (log_level, "record %d type %s", i,
458 case Z_External_sutrs:
459 if (rec->u.octet_aligned->len > 170)
460 yaz_log (log_level, "%d bytes:\n%.168s ...",
464 yaz_log (log_level, "%d bytes:\n%s",
468 case Z_External_octet :
469 if (rec->u.octet_aligned->len > 170)
470 yaz_log (log_level, "%d bytes:\n%.168s ...",
471 rec->u.octet_aligned->len,
472 rec->u.octet_aligned->buf);
474 yaz_log (log_level, "%d bytes\n%s",
475 rec->u.octet_aligned->len,
476 rec->u.octet_aligned->buf);
485 /* result set delete */
486 int ztest_delete (void *handle, bend_delete_rr *rr)
488 if (rr->num_setnames == 1 && !strcmp (rr->setnames[0], "1"))
489 rr->delete_status = Z_DeleteStatus_success;
491 rr->delete_status = Z_DeleteStatus_resultSetDidNotExist;
495 /* Our sort handler really doesn't sort... */
496 int ztest_sort (void *handle, bend_sort_rr *rr)
499 rr->sort_status = Z_SortResponse_success;
504 /* present request handler */
505 int ztest_present (void *handle, bend_present_rr *rr)
510 /* retrieval of a single record (present, and piggy back search) */
511 int ztest_fetch(void *handle, bend_fetch_rr *r)
514 const Odr_oid *oid = r->request_format;
517 r->basename = "Default";
518 r->output_format = r->request_format;
520 if (oid && !oid_oidcmp(oid, yaz_oid_recsyn_sutrs))
522 /* this section returns a small record */
525 sprintf(buf, "This is dummy SUTRS record number %d\n", r->number);
527 r->len = strlen(buf);
528 r->record = (char *) odr_malloc (r->stream, r->len+1);
529 strcpy(r->record, buf);
531 else if (oid && !oid_oidcmp(oid, yaz_oid_recsyn_grs_1))
534 r->record = (char*) dummy_grs_record(r->number, r->stream);
541 else if (oid && !oid_oidcmp(oid, yaz_oid_recsyn_postscript))
547 sprintf (fname, "part.%d.ps", r->number);
548 f = fopen(fname, "rb");
554 fseek (f, 0L, SEEK_END);
556 if (size <= 0 || size >= 5000000)
561 fseek (f, 0L, SEEK_SET);
562 r->record = (char*) odr_malloc (r->stream, size);
564 fread (r->record, size, 1, f);
567 else if (oid && !oid_oidcmp(oid, yaz_oid_recsyn_xml))
569 if ((cp = dummy_xml_record (r->number, r->stream)))
577 r->surrogate_flag = 1;
581 else if ((cp = dummy_marc_record(r->number, r->stream)))
585 r->output_format = odr_oiddup(r->stream, yaz_oid_recsyn_usmarc);
597 * silly dummy-scan what reads words from a file.
599 int ztest_scan(void *handle, bend_scan_rr *q)
602 static struct scan_entry list[200];
603 static char entries[200][80];
607 int term_position_req = q->term_position;
608 int num_entries_req = q->num_entries;
610 /* Throw Database unavailable if other than Default or Slow */
611 if (!yaz_matchstr (q->basenames[0], "Default"))
612 ; /* Default is OK in our test */
613 else if(!yaz_matchstr (q->basenames[0], "Slow"))
623 q->errstring = q->basenames[0];
630 q->status = BEND_SCAN_SUCCESS;
631 if (!f && !(f = fopen("dummy-words", "r")))
633 perror("dummy-words");
636 if (q->num_entries > 200)
644 if (q->term->term->which != Z_Term_general)
646 q->errcode = 229; /* unsupported term type */
649 if (*q->step_size != 0)
651 q->errcode = 205; /*Only zero step size supported for Scan */
654 len = q->term->term->u.general->len;
655 if (len >= sizeof(term))
656 len = sizeof(term)-1;
657 memcpy(term, q->term->term->u.general->buf, len);
660 else if (q->scanClause)
662 strncpy(term, q->scanClause, sizeof(term)-1);
663 term[sizeof(term)-1] = '\0';
668 for (p = term; *p; p++)
669 if (islower(*(unsigned char *) p))
672 fseek(f, 0, SEEK_SET);
675 for (i = 0, pos = 0; fscanf(f, " %79[^:]:%d", entries[pos], &hits[pos]) == 2;
676 i++, pos < 199 ? pos++ : (pos = 0))
678 if (!q->num_entries && strcmp(entries[pos], term) >= 0) /* s-point fnd */
680 if ((q->term_position = term_position_req) > i + 1)
682 q->term_position = i + 1;
683 q->status = BEND_SCAN_PARTIAL;
685 for (; q->num_entries < q->term_position; q->num_entries++)
689 po = pos - q->term_position + q->num_entries+1; /* find pos */
693 if (!strcmp (term, "SD") && q->num_entries == 2)
695 list[q->num_entries].term = entries[pos];
696 list[q->num_entries].occurrences = -1;
697 list[q->num_entries].errcode = 233;
698 list[q->num_entries].errstring = "SD for Scan Term";
702 list[q->num_entries].term = entries[po];
703 list[q->num_entries].occurrences = hits[po];
707 else if (q->num_entries)
709 list[q->num_entries].term = entries[pos];
710 list[q->num_entries].occurrences = hits[pos];
713 if (q->num_entries >= num_entries_req)
717 q->status = BEND_SCAN_PARTIAL;
721 int ztest_explain(void *handle, bend_explain_rr *rr)
723 if (rr->database && !strcmp(rr->database, "Default"))
725 rr->explain_buf = "<explain>\n"
727 "\t\t<host>localhost</host>\n"
728 "\t\t<port>210</port>\n"
735 int ztest_update(void *handle, bend_update_rr *rr)
737 rr->operation_status = "success";
741 bend_initresult *bend_init(bend_initrequest *q)
743 bend_initresult *r = (bend_initresult *)
744 odr_malloc (q->stream, sizeof(*r));
745 int *counter = (int *) xmalloc (sizeof(int));
749 log_level=yaz_log_module_level("ztest");
756 r->handle = counter; /* user handle, in this case a simple int */
757 q->bend_sort = ztest_sort; /* register sort handler */
758 q->bend_search = ztest_search; /* register search handler */
759 q->bend_present = ztest_present; /* register present handle */
760 q->bend_esrequest = ztest_esrequest;
761 q->bend_delete = ztest_delete;
762 q->bend_fetch = ztest_fetch;
763 q->bend_scan = ztest_scan;
765 q->bend_explain = ztest_explain;
767 q->bend_srw_scan = ztest_scan;
768 q->bend_srw_update = ztest_update;
770 q->query_charset = "ISO-8859-1";
771 q->records_in_same_charset = 0;
776 void bend_close(void *handle)
778 xfree (handle); /* release our user-defined handle */
782 int main(int argc, char **argv)
784 return statserv_main(argc, argv, bend_init, bend_close);
789 * indent-tabs-mode: nil
791 * vim: shiftwidth=4 tabstop=8 expandtab