2 * Copyright (C) 1995-1999, Index Data
4 * Sebastian Hammer, Adam Dickmeiss
7 * Revision 1.76 2000-03-15 15:00:31 adam
8 * First work on threaded version.
10 * Revision 1.75 1999/11/30 13:48:04 adam
11 * Improved installation. Updated for inclusion of YAZ header files.
13 * Revision 1.74 1999/11/29 15:13:26 adam
14 * Server sets implementationName - and Version.
16 * Revision 1.73 1999/11/04 15:00:45 adam
17 * Implemented delete result set(s).
19 * Revision 1.71 1999/07/14 10:59:26 adam
20 * Changed functions isc_getmethod, isams_getmethod.
21 * Improved fatal error handling (such as missing EXPLAIN schema).
23 * Revision 1.70 1999/06/10 12:14:56 adam
24 * Fixed to use bend_start instead of pre_init.
26 * Revision 1.69 1999/06/10 09:20:03 adam
27 * Minor change to pre_init handler.
29 * Revision 1.68 1999/05/26 07:49:13 adam
32 * Revision 1.67 1999/02/02 14:51:14 adam
33 * Updated WIN32 code specific sections. Changed header.
35 * Revision 1.66 1998/10/28 10:54:41 adam
38 * Revision 1.65 1998/10/18 07:54:54 adam
39 * Additional info added for diagnostics 114 (Unsupported use attribute) and
40 * 121 (Unsupported attribute set).
42 * Revision 1.64 1998/09/22 10:48:21 adam
43 * Minor changes in search API.
45 * Revision 1.63 1998/09/02 13:53:21 adam
46 * Extra parameter decode added to search routines to implement
49 * Revision 1.62 1998/08/06 14:35:28 adam
50 * Routine bend_deleterequest removed.
52 * Revision 1.61 1998/06/24 12:16:15 adam
53 * Support for relations on text operands. Open range support in
54 * DFA module (i.e. [-j], [g-]).
56 * Revision 1.60 1998/06/22 11:36:49 adam
57 * Added authentication check facility to zebra.
59 * Revision 1.59 1998/06/12 12:22:13 adam
62 * Revision 1.58 1998/05/27 16:57:46 adam
63 * Zebra returns surrogate diagnostic for single records when
66 * Revision 1.57 1998/04/03 14:45:18 adam
67 * Fixed setting of last_in_set in bend_fetch.
69 * Revision 1.56 1998/03/05 08:45:13 adam
70 * New result set model and modular ranking system. Moved towards
71 * descent server API. System information stored as "SGML" records.
73 * Revision 1.55 1998/02/10 12:03:06 adam
76 * Revision 1.54 1998/01/29 13:39:13 adam
77 * Compress ISAM is default.
79 * Revision 1.53 1998/01/12 15:04:09 adam
80 * The test option (-s) only uses read-lock (and not write lock).
82 * Revision 1.52 1997/11/18 10:05:08 adam
83 * Changed character map facility so that admin can specify character
84 * mapping files for each register type, w, p, etc.
86 * Revision 1.51 1997/10/27 14:33:06 adam
87 * Moved towards generic character mapping depending on "structure"
88 * field in abstract syntax file. Fixed a few memory leaks. Fixed
89 * bug with negative integers when doing searches with relational
92 * Revision 1.50 1997/09/29 09:08:36 adam
93 * Revised locking system to be thread safe for the server.
95 * Revision 1.49 1997/09/25 14:57:23 adam
98 * Revision 1.48 1997/09/17 12:19:19 adam
99 * Zebra version corresponds to YAZ version 1.4.
100 * Changed Zebra server so that it doesn't depend on global common_resource.
102 * Revision 1.47 1997/09/04 13:58:36 adam
103 * New retrieve/extract method tellf (added).
104 * Added O_BINARY for open calls.
106 * Revision 1.46 1997/07/28 08:30:47 adam
107 * Server returns diagnostic 14 when record doesn't exist.
109 * Revision 1.45 1996/12/23 15:30:45 adam
110 * Work on truncation.
111 * Bug fix: result sets weren't deleted after server shut down.
113 * Revision 1.44 1996/12/11 12:08:01 adam
114 * Added better compression.
116 * Revision 1.43 1996/11/15 15:03:58 adam
117 * Logging of execution speed by using the times(2) call.
119 * Revision 1.42 1996/11/08 11:10:36 adam
120 * Buffers used during file match got bigger.
121 * Compressed ISAM support everywhere.
122 * Bug fixes regarding masking characters in queries.
123 * Redesigned Regexp-2 queries.
125 * Revision 1.41 1996/10/29 14:09:56 adam
126 * Use of cisam system - enabled if setting isamc is 1.
128 * Revision 1.40 1996/06/04 10:19:02 adam
129 * Minor changes - removed include of ctype.h.
131 * Revision 1.39 1996/05/31 09:07:05 quinn
132 * Work on character-set handling
134 * Revision 1.38 1996/05/14 11:34:01 adam
135 * Scan support in multiple registers/databases.
137 * Revision 1.37 1996/05/14 06:16:48 adam
138 * Compact use/set bytes used in search service.
140 * Revision 1.36 1996/05/01 13:46:37 adam
141 * First work on multiple records in one file.
142 * New option, -offset, to the "unread" command in the filter module.
144 * Revision 1.35 1996/03/26 16:01:14 adam
145 * New setting lockPath: directory of various lock files.
147 * Revision 1.34 1996/03/20 09:36:46 adam
148 * Function dict_lookup_grep got extra parameter, init_pos, which marks
149 * from which position in pattern approximate pattern matching should occur.
150 * Approximate pattern matching is used in relevance=re-2.
152 * Revision 1.33 1996/01/17 14:57:56 adam
153 * Prototype changed for reader functions in extract/retrieve. File
154 * is identified by 'void *' instead of 'int.
156 * Revision 1.32 1995/12/11 09:12:58 adam
157 * The rec_get function returns NULL if record doesn't exist - will
158 * happen in the server if the result set records have been deleted since
159 * the creation of the set (i.e. the search).
160 * The server saves a result temporarily if it is 'volatile', i.e. the
161 * set is register dependent.
163 * Revision 1.31 1995/12/08 16:22:56 adam
164 * Work on update while servers are running. Three lock files introduced.
165 * The servers reload their registers when necessary, but they don't
166 * reestablish result sets yet.
168 * Revision 1.30 1995/12/07 17:38:48 adam
169 * Work locking mechanisms for concurrent updates/commit.
171 * Revision 1.29 1995/12/04 14:22:32 adam
172 * Extra arg to recType_byName.
173 * Started work on new regular expression parsed input to
174 * structured records.
176 * Revision 1.28 1995/11/28 09:09:48 adam
177 * Zebra config renamed.
178 * Use setting 'recordId' to identify record now.
179 * Bug fix in recindex.c: rec_release_blocks was invokeded even
180 * though the blocks were already released.
181 * File traversal properly deletes records when needed.
183 * Revision 1.27 1995/11/27 13:58:54 adam
184 * New option -t. storeStore data implemented in server.
186 * Revision 1.26 1995/11/25 10:24:07 adam
187 * More record fields - they are enumerated now.
188 * New options: flagStoreData flagStoreKey.
190 * Revision 1.25 1995/11/21 15:29:13 adam
191 * Config file 'base' read by default by both indexer and server.
193 * Revision 1.24 1995/11/20 16:59:47 adam
194 * New update method: the 'old' keys are saved for each records.
196 * Revision 1.23 1995/11/16 17:00:56 adam
197 * Better logging of rpn query.
199 * Revision 1.22 1995/11/16 15:34:55 adam
200 * Uses new record management system in both indexer and server.
202 * Revision 1.21 1995/11/01 16:25:52 quinn
203 * *** empty log message ***
205 * Revision 1.20 1995/10/27 14:00:12 adam
206 * Implemented detection of database availability.
208 * Revision 1.19 1995/10/17 18:02:11 adam
209 * New feature: databases. Implemented as prefix to words in dictionary.
211 * Revision 1.18 1995/10/16 14:03:09 quinn
212 * Changes to support element set names and espec1
214 * Revision 1.17 1995/10/16 09:32:40 adam
215 * More work on relational op.
217 * Revision 1.16 1995/10/13 12:26:44 adam
218 * Optimization of truncation.
220 * Revision 1.15 1995/10/12 12:40:55 adam
221 * Bug fixes in rpn_prox.
223 * Revision 1.14 1995/10/09 16:18:37 adam
224 * Function dict_lookup_grep got extra client data parameter.
226 * Revision 1.13 1995/10/06 14:38:00 adam
227 * New result set method: r_score.
228 * Local no (sysno) and score is transferred to retrieveCtrl.
230 * Revision 1.12 1995/10/06 13:52:06 adam
231 * Bug fixes. Handler may abort further scanning.
233 * Revision 1.11 1995/10/06 10:43:57 adam
234 * Scan added. 'occurrences' in scan entries not set yet.
236 * Revision 1.10 1995/10/02 16:43:32 quinn
237 * Set default resulting record type in fetch.
239 * Revision 1.9 1995/10/02 15:18:52 adam
240 * New member in recRetrieveCtrl: diagnostic.
242 * Revision 1.8 1995/09/28 09:19:47 adam
243 * xfree/xmalloc used everywhere.
244 * Extract/retrieve method seems to work for text records.
246 * Revision 1.7 1995/09/27 16:17:32 adam
247 * More work on retrieve.
249 * Revision 1.6 1995/09/08 08:53:22 adam
250 * Record buffer maintained in server_info.
252 * Revision 1.5 1995/09/06 16:11:18 adam
253 * Option: only one word key per file.
255 * Revision 1.4 1995/09/06 10:33:04 adam
256 * More work on present. Some log messages removed.
258 * Revision 1.3 1995/09/05 15:28:40 adam
259 * More work on search engine.
261 * Revision 1.2 1995/09/04 12:33:43 adam
262 * Various cleanup. YAZ util used instead.
264 * Revision 1.1 1995/09/04 09:10:41 adam
265 * More work on index add/del/update.
266 * Merge sort implemented.
267 * Initial work on z39 server.
281 #include <yaz/data1.h>
292 #include "zebrasdr.h"
295 static int bend_sort (void *handle, bend_sort_rr *rr);
296 static int bend_delete (void *handle, bend_delete_rr *rr);
297 static int bend_esrequest (void *handle, bend_esrequest_rr *rr);
299 bend_initresult *bend_init (bend_initrequest *q)
301 bend_initresult *r = (bend_initresult *)
302 odr_malloc (q->stream, sizeof(*r));
304 struct statserv_options_block *sob;
310 q->bend_sort = bend_sort;
311 q->bend_delete = bend_delete;
312 q->bend_esrequest = bend_esrequest;
314 q->implementation_name = "Z'mbol Information Server";
315 q->implementation_version = "Z'mbol 1.0";
317 logf (LOG_DEBUG, "bend_init");
319 sob = statserv_getcontrol ();
320 if (!(zh = zebra_open (sob->handle)))
322 logf (LOG_FATAL, "Failed to open Zebra `%s'", sob->configname);
328 if (q->auth->which == Z_IdAuthentication_open)
330 char *openpass = xstrdup (q->auth->u.open);
331 char *cp = strchr (openpass, '/');
335 user = nmem_strdup (odr_getmem (q->stream), openpass);
336 passwd = nmem_strdup (odr_getmem (q->stream), cp+1);
341 if (zebra_auth (zh->service, user, passwd))
352 bend_searchresult *bend_search (void *handle, bend_searchrequest *q, int *fd)
354 ZebraHandle zh = (ZebraHandle) handle;
355 bend_searchresult *r = (bend_searchresult *)
356 odr_malloc (q->stream, sizeof(*r));
362 logf (LOG_LOG, "ResultSet '%s'", q->setname);
363 switch (q->query->which)
365 case Z_Query_type_1: case Z_Query_type_101:
366 zebra_search_rpn (zh, q->decode, q->stream, q->query->u.type_1,
367 q->num_bases, q->basenames, q->setname);
368 r->errcode = zh->errCode;
369 r->errstring = zh->errString;
374 r->errstring = "type-2";
382 bend_fetchresult *bend_fetch (void *handle, bend_fetchrequest *q, int *num)
384 ZebraHandle zh = (ZebraHandle) handle;
385 bend_fetchresult *r = (bend_fetchresult *)
386 odr_malloc (q->stream, sizeof(*r));
387 ZebraRetrievalRecord retrievalRecord;
389 retrievalRecord.position = q->number;
392 zebra_records_retrieve (zh, q->stream, q->setname, q->comp,
393 q->format, 1, &retrievalRecord);
394 if (zh->errCode) /* non Surrogate Diagnostic */
396 r->errcode = zh->errCode;
397 r->errstring = zh->errString;
399 else if (retrievalRecord.errCode) /* Surrogate Diagnostic */
401 q->surrogate_flag = 1;
402 r->errcode = retrievalRecord.errCode;
403 r->errstring = retrievalRecord.errString;
404 r->basename = retrievalRecord.base;
406 else /* Database Record */
409 r->basename = retrievalRecord.base;
410 r->record = retrievalRecord.buf;
411 r->len = retrievalRecord.len;
412 r->format = retrievalRecord.format;
417 bend_scanresult *bend_scan (void *handle, bend_scanrequest *q, int *num)
419 ZebraScanEntry *entries;
420 ZebraHandle zh = (ZebraHandle) handle;
421 bend_scanresult *r = (bend_scanresult *)
422 odr_malloc (q->stream, sizeof(*r));
425 r->term_position = q->term_position;
426 r->num_entries = q->num_entries;
428 r->entries = (struct scan_entry *)
429 odr_malloc (q->stream, sizeof(*r->entries) * q->num_entries);
430 zebra_scan (zh, q->stream, q->term,
432 q->num_bases, q->basenames,
434 &r->num_entries, &entries, &is_partial);
436 r->status = BEND_SCAN_PARTIAL;
438 r->status = BEND_SCAN_SUCCESS;
439 for (i = 0; i < r->num_entries; i++)
441 r->entries[i].term = entries[i].term;
442 r->entries[i].occurrences = entries[i].occurrences;
444 r->errcode = zh->errCode;
445 r->errstring = zh->errString;
449 void bend_close (void *handle)
451 zebra_close ((ZebraHandle) handle);
454 int bend_sort (void *handle, bend_sort_rr *rr)
456 ZebraHandle zh = (ZebraHandle) handle;
458 zebra_sort (zh, rr->stream,
459 rr->num_input_setnames, (const char **) rr->input_setnames,
460 rr->output_setname, rr->sort_sequence, &rr->sort_status);
461 rr->errcode = zh->errCode;
462 rr->errstring = zh->errString;
466 int bend_delete (void *handle, bend_delete_rr *rr)
468 ZebraHandle zh = (ZebraHandle) handle;
470 rr->delete_status = zebra_deleleResultSet(zh, rr->function,
471 rr->num_setnames, rr->setnames,
476 static int es_admin_request (ZebraHandle zh, Z_AdminEsRequest *r)
478 switch (r->toKeep->which)
480 case Z_ESAdminOriginPartToKeep_reIndex:
481 yaz_log(LOG_LOG, "adm-reindex");
483 case Z_ESAdminOriginPartToKeep_truncate:
484 yaz_log(LOG_LOG, "adm-truncate");
486 case Z_ESAdminOriginPartToKeep_delete:
487 yaz_log(LOG_LOG, "adm-delete");
489 case Z_ESAdminOriginPartToKeep_create:
490 yaz_log(LOG_LOG, "adm-create");
491 zebra_admin_create (zh, r->toKeep->databaseName);
493 case Z_ESAdminOriginPartToKeep_import:
494 yaz_log(LOG_LOG, "adm-import");
496 case Z_ESAdminOriginPartToKeep_refresh:
497 yaz_log(LOG_LOG, "adm-refresh");
499 case Z_ESAdminOriginPartToKeep_commit:
500 yaz_log(LOG_LOG, "adm-commit");
503 yaz_log(LOG_LOG, "unknown admin");
506 if (r->toKeep->databaseName)
508 yaz_log(LOG_LOG, "database %s", r->toKeep->databaseName);
513 static int es_admin (ZebraHandle zh, Z_Admin *r)
517 case Z_Admin_esRequest:
518 es_admin_request (zh, r->u.esRequest);
520 case Z_Admin_taskPackage:
521 yaz_log (LOG_LOG, "adm taskpackage (unhandled)");
531 int bend_esrequest (void *handle, bend_esrequest_rr *rr)
533 ZebraHandle zh = (ZebraHandle) handle;
535 yaz_log(LOG_LOG, "function: %d", *rr->esr->function);
536 if (rr->esr->packageName)
537 yaz_log(LOG_LOG, "packagename: %s", rr->esr->packageName);
538 yaz_log(LOG_LOG, "Waitaction: %d", *rr->esr->waitAction);
540 if (!rr->esr->taskSpecificParameters)
542 yaz_log (LOG_WARN, "No task specific parameters");
544 else if (rr->esr->taskSpecificParameters->which == Z_External_ESAdmin)
546 es_admin (zh, rr->esr->taskSpecificParameters->u.adminService);
547 rr->errcode = zh->errCode;
548 rr->errstring = zh->errString;
550 else if (rr->esr->taskSpecificParameters->which == Z_External_itemOrder)
552 Z_ItemOrder *it = rr->esr->taskSpecificParameters->u.itemOrder;
553 yaz_log (LOG_LOG, "Received ItemOrder");
557 case Z_IOItemOrder_esRequest:
559 case Z_ItemOrder_esRequest:
562 Z_IORequest *ir = it->u.esRequest;
563 Z_IOOriginPartToKeep *k = ir->toKeep;
564 Z_IOOriginPartNotToKeep *n = ir->notToKeep;
568 if (k->contact->name)
569 yaz_log(LOG_LOG, "contact name %s", k->contact->name);
570 if (k->contact->phone)
571 yaz_log(LOG_LOG, "contact phone %s", k->contact->phone);
572 if (k->contact->email)
573 yaz_log(LOG_LOG, "contact email %s", k->contact->email);
577 yaz_log(LOG_LOG, "Billing info (not shown)");
580 if (n->resultSetItem)
582 yaz_log(LOG_LOG, "resultsetItem");
583 yaz_log(LOG_LOG, "setId: %s", n->resultSetItem->resultSetId);
584 yaz_log(LOG_LOG, "item: %d", *n->resultSetItem->item);
589 Z_External *r = (Z_External*) n->itemRequest;
590 ILL_ItemRequest *item_req = 0;
591 ILL_Request *ill_req = 0;
592 if (r->direct_reference)
594 oident *ent = oid_getentbyoid(r->direct_reference);
596 yaz_log(LOG_LOG, "OID %s", ent->desc);
597 if (ent && ent->value == VAL_ISO_ILL_1)
599 yaz_log (LOG_LOG, "ItemRequest");
600 if (r->which == ODR_EXTERNAL_single)
602 odr_setbuf(rr->decode,
603 r->u.single_ASN1_type->buf,
604 r->u.single_ASN1_type->len, 0);
606 if (!ill_ItemRequest (rr->decode, &item_req, 0, 0))
609 "Couldn't decode ItemRequest %s near %d",
610 odr_errmsg(odr_geterror(rr->decode)),
611 odr_offset(rr->decode));
612 yaz_log(LOG_LOG, "PDU dump:");
613 odr_dumpBER(log_file(),
614 r->u.single_ASN1_type->buf,
615 r->u.single_ASN1_type->len);
619 ill_ItemRequest (rr->print, &item_req, 0,
621 odr_reset (rr->print);
624 if (!item_req && r->which == ODR_EXTERNAL_single)
626 yaz_log (LOG_LOG, "ILLRequest");
627 odr_setbuf(rr->decode,
628 r->u.single_ASN1_type->buf,
629 r->u.single_ASN1_type->len, 0);
631 if (!ill_Request (rr->decode, &ill_req, 0, 0))
634 "Couldn't decode ILLRequest %s near %d",
635 odr_errmsg(odr_geterror(rr->decode)),
636 odr_offset(rr->decode));
637 yaz_log(LOG_LOG, "PDU dump:");
638 odr_dumpBER(log_file(),
639 r->u.single_ASN1_type->buf,
640 r->u.single_ASN1_type->len);
644 ill_Request (rr->print, &ill_req, 0,
646 odr_reset (rr->print);
653 yaz_log (LOG_LOG, "ILL protocol version = %d",
654 *item_req->protocol_version_num);
662 else if (rr->esr->taskSpecificParameters->which == Z_External_update)
664 Z_IUUpdate *up = rr->esr->taskSpecificParameters->u.update;
665 yaz_log (LOG_LOG, "Received DB Update");
666 if (up->which == Z_IUUpdate_esRequest)
668 Z_IUUpdateEsRequest *esRequest = up->u.esRequest;
669 Z_IUOriginPartToKeep *toKeep = esRequest->toKeep;
670 Z_IUSuppliedRecords *notToKeep = esRequest->notToKeep;
672 yaz_log (LOG_LOG, "action");
675 switch (*toKeep->action)
677 case Z_IUOriginPartToKeep_recordInsert:
678 yaz_log (LOG_LOG, " recordInsert");
680 case Z_IUOriginPartToKeep_recordReplace:
681 yaz_log (LOG_LOG, " recordUpdate");
683 case Z_IUOriginPartToKeep_recordDelete:
684 yaz_log (LOG_LOG, " recordDelete");
686 case Z_IUOriginPartToKeep_elementUpdate:
687 yaz_log (LOG_LOG, " elementUpdate");
689 case Z_IUOriginPartToKeep_specialUpdate:
690 yaz_log (LOG_LOG, " specialUpdate");
693 yaz_log (LOG_LOG, " unknown (%d)", *toKeep->action);
696 if (toKeep->databaseName)
698 yaz_log (LOG_LOG, "database: %s", toKeep->databaseName);
699 if (!strcmp(toKeep->databaseName, "fault"))
702 rr->errstring = toKeep->databaseName;
704 if (!strcmp(toKeep->databaseName, "accept"))
710 for (i = 0; i < notToKeep->num; i++)
712 Z_External *rec = notToKeep->elements[i]->record;
714 if (rec->direct_reference)
716 struct oident *oident;
717 oident = oid_getentbyoid(rec->direct_reference);
719 yaz_log (LOG_LOG, "record %d type %s", i,
724 case Z_External_sutrs:
725 if (rec->u.octet_aligned->len > 170)
726 yaz_log (LOG_LOG, "%d bytes:\n%.168s ...",
730 yaz_log (LOG_LOG, "%d bytes:\n%s",
734 case Z_External_octet :
735 if (rec->u.octet_aligned->len > 170)
736 yaz_log (LOG_LOG, "%d bytes:\n%.168s ...",
737 rec->u.octet_aligned->len,
738 rec->u.octet_aligned->buf);
740 yaz_log (LOG_LOG, "%d bytes\n%s",
741 rec->u.octet_aligned->len,
742 rec->u.octet_aligned->buf);
750 yaz_log (LOG_WARN, "Unknown Extended Service(%d)",
751 rr->esr->taskSpecificParameters->which);
757 static void bend_start (struct statserv_options_block *sob)
764 char *pidfile = "zebrasrv.pid";
765 int fd = creat (pidfile, 0666);
767 logf (LOG_WARN|LOG_ERRNO, "creat %s", pidfile);
772 sprintf (pidstr, "%ld", (long) getpid ());
773 write (fd, pidstr, strlen(pidstr));
779 zebra_stop((ZebraService) sob->handle);
780 sob->handle = zebra_start(sob->configname);
783 static void bend_stop(struct statserv_options_block *sob)
786 zebra_stop(sob->handle);
790 int main (int argc, char **argv)
792 struct statserv_options_block *sob;
794 sob = statserv_getcontrol ();
795 strcpy (sob->configname, FNAME_CONFIG);
796 sob->bend_start = bend_start;
797 sob->bend_stop = bend_stop;
804 statserv_setcontrol (sob);
806 return statserv_main (argc, argv);