2 * Copyright (C) 1995-1999, Index Data
4 * Sebastian Hammer, Adam Dickmeiss
7 * Revision 1.77 2000-03-20 19:08:36 adam
8 * Added remote record import using Z39.50 extended services and Segment
11 * Revision 1.76 2000/03/15 15:00:31 adam
12 * First work on threaded version.
14 * Revision 1.75 1999/11/30 13:48:04 adam
15 * Improved installation. Updated for inclusion of YAZ header files.
17 * Revision 1.74 1999/11/29 15:13:26 adam
18 * Server sets implementationName - and Version.
20 * Revision 1.73 1999/11/04 15:00:45 adam
21 * Implemented delete result set(s).
23 * Revision 1.71 1999/07/14 10:59:26 adam
24 * Changed functions isc_getmethod, isams_getmethod.
25 * Improved fatal error handling (such as missing EXPLAIN schema).
27 * Revision 1.70 1999/06/10 12:14:56 adam
28 * Fixed to use bend_start instead of pre_init.
30 * Revision 1.69 1999/06/10 09:20:03 adam
31 * Minor change to pre_init handler.
33 * Revision 1.68 1999/05/26 07:49:13 adam
36 * Revision 1.67 1999/02/02 14:51:14 adam
37 * Updated WIN32 code specific sections. Changed header.
39 * Revision 1.66 1998/10/28 10:54:41 adam
42 * Revision 1.65 1998/10/18 07:54:54 adam
43 * Additional info added for diagnostics 114 (Unsupported use attribute) and
44 * 121 (Unsupported attribute set).
46 * Revision 1.64 1998/09/22 10:48:21 adam
47 * Minor changes in search API.
49 * Revision 1.63 1998/09/02 13:53:21 adam
50 * Extra parameter decode added to search routines to implement
53 * Revision 1.62 1998/08/06 14:35:28 adam
54 * Routine bend_deleterequest removed.
56 * Revision 1.61 1998/06/24 12:16:15 adam
57 * Support for relations on text operands. Open range support in
58 * DFA module (i.e. [-j], [g-]).
60 * Revision 1.60 1998/06/22 11:36:49 adam
61 * Added authentication check facility to zebra.
63 * Revision 1.59 1998/06/12 12:22:13 adam
66 * Revision 1.58 1998/05/27 16:57:46 adam
67 * Zebra returns surrogate diagnostic for single records when
70 * Revision 1.57 1998/04/03 14:45:18 adam
71 * Fixed setting of last_in_set in bend_fetch.
73 * Revision 1.56 1998/03/05 08:45:13 adam
74 * New result set model and modular ranking system. Moved towards
75 * descent server API. System information stored as "SGML" records.
77 * Revision 1.55 1998/02/10 12:03:06 adam
80 * Revision 1.54 1998/01/29 13:39:13 adam
81 * Compress ISAM is default.
83 * Revision 1.53 1998/01/12 15:04:09 adam
84 * The test option (-s) only uses read-lock (and not write lock).
86 * Revision 1.52 1997/11/18 10:05:08 adam
87 * Changed character map facility so that admin can specify character
88 * mapping files for each register type, w, p, etc.
90 * Revision 1.51 1997/10/27 14:33:06 adam
91 * Moved towards generic character mapping depending on "structure"
92 * field in abstract syntax file. Fixed a few memory leaks. Fixed
93 * bug with negative integers when doing searches with relational
96 * Revision 1.50 1997/09/29 09:08:36 adam
97 * Revised locking system to be thread safe for the server.
99 * Revision 1.49 1997/09/25 14:57:23 adam
102 * Revision 1.48 1997/09/17 12:19:19 adam
103 * Zebra version corresponds to YAZ version 1.4.
104 * Changed Zebra server so that it doesn't depend on global common_resource.
106 * Revision 1.47 1997/09/04 13:58:36 adam
107 * New retrieve/extract method tellf (added).
108 * Added O_BINARY for open calls.
110 * Revision 1.46 1997/07/28 08:30:47 adam
111 * Server returns diagnostic 14 when record doesn't exist.
113 * Revision 1.45 1996/12/23 15:30:45 adam
114 * Work on truncation.
115 * Bug fix: result sets weren't deleted after server shut down.
117 * Revision 1.44 1996/12/11 12:08:01 adam
118 * Added better compression.
120 * Revision 1.43 1996/11/15 15:03:58 adam
121 * Logging of execution speed by using the times(2) call.
123 * Revision 1.42 1996/11/08 11:10:36 adam
124 * Buffers used during file match got bigger.
125 * Compressed ISAM support everywhere.
126 * Bug fixes regarding masking characters in queries.
127 * Redesigned Regexp-2 queries.
129 * Revision 1.41 1996/10/29 14:09:56 adam
130 * Use of cisam system - enabled if setting isamc is 1.
132 * Revision 1.40 1996/06/04 10:19:02 adam
133 * Minor changes - removed include of ctype.h.
135 * Revision 1.39 1996/05/31 09:07:05 quinn
136 * Work on character-set handling
138 * Revision 1.38 1996/05/14 11:34:01 adam
139 * Scan support in multiple registers/databases.
141 * Revision 1.37 1996/05/14 06:16:48 adam
142 * Compact use/set bytes used in search service.
144 * Revision 1.36 1996/05/01 13:46:37 adam
145 * First work on multiple records in one file.
146 * New option, -offset, to the "unread" command in the filter module.
148 * Revision 1.35 1996/03/26 16:01:14 adam
149 * New setting lockPath: directory of various lock files.
151 * Revision 1.34 1996/03/20 09:36:46 adam
152 * Function dict_lookup_grep got extra parameter, init_pos, which marks
153 * from which position in pattern approximate pattern matching should occur.
154 * Approximate pattern matching is used in relevance=re-2.
156 * Revision 1.33 1996/01/17 14:57:56 adam
157 * Prototype changed for reader functions in extract/retrieve. File
158 * is identified by 'void *' instead of 'int.
160 * Revision 1.32 1995/12/11 09:12:58 adam
161 * The rec_get function returns NULL if record doesn't exist - will
162 * happen in the server if the result set records have been deleted since
163 * the creation of the set (i.e. the search).
164 * The server saves a result temporarily if it is 'volatile', i.e. the
165 * set is register dependent.
167 * Revision 1.31 1995/12/08 16:22:56 adam
168 * Work on update while servers are running. Three lock files introduced.
169 * The servers reload their registers when necessary, but they don't
170 * reestablish result sets yet.
172 * Revision 1.30 1995/12/07 17:38:48 adam
173 * Work locking mechanisms for concurrent updates/commit.
175 * Revision 1.29 1995/12/04 14:22:32 adam
176 * Extra arg to recType_byName.
177 * Started work on new regular expression parsed input to
178 * structured records.
180 * Revision 1.28 1995/11/28 09:09:48 adam
181 * Zebra config renamed.
182 * Use setting 'recordId' to identify record now.
183 * Bug fix in recindex.c: rec_release_blocks was invokeded even
184 * though the blocks were already released.
185 * File traversal properly deletes records when needed.
187 * Revision 1.27 1995/11/27 13:58:54 adam
188 * New option -t. storeStore data implemented in server.
190 * Revision 1.26 1995/11/25 10:24:07 adam
191 * More record fields - they are enumerated now.
192 * New options: flagStoreData flagStoreKey.
194 * Revision 1.25 1995/11/21 15:29:13 adam
195 * Config file 'base' read by default by both indexer and server.
197 * Revision 1.24 1995/11/20 16:59:47 adam
198 * New update method: the 'old' keys are saved for each records.
200 * Revision 1.23 1995/11/16 17:00:56 adam
201 * Better logging of rpn query.
203 * Revision 1.22 1995/11/16 15:34:55 adam
204 * Uses new record management system in both indexer and server.
206 * Revision 1.21 1995/11/01 16:25:52 quinn
207 * *** empty log message ***
209 * Revision 1.20 1995/10/27 14:00:12 adam
210 * Implemented detection of database availability.
212 * Revision 1.19 1995/10/17 18:02:11 adam
213 * New feature: databases. Implemented as prefix to words in dictionary.
215 * Revision 1.18 1995/10/16 14:03:09 quinn
216 * Changes to support element set names and espec1
218 * Revision 1.17 1995/10/16 09:32:40 adam
219 * More work on relational op.
221 * Revision 1.16 1995/10/13 12:26:44 adam
222 * Optimization of truncation.
224 * Revision 1.15 1995/10/12 12:40:55 adam
225 * Bug fixes in rpn_prox.
227 * Revision 1.14 1995/10/09 16:18:37 adam
228 * Function dict_lookup_grep got extra client data parameter.
230 * Revision 1.13 1995/10/06 14:38:00 adam
231 * New result set method: r_score.
232 * Local no (sysno) and score is transferred to retrieveCtrl.
234 * Revision 1.12 1995/10/06 13:52:06 adam
235 * Bug fixes. Handler may abort further scanning.
237 * Revision 1.11 1995/10/06 10:43:57 adam
238 * Scan added. 'occurrences' in scan entries not set yet.
240 * Revision 1.10 1995/10/02 16:43:32 quinn
241 * Set default resulting record type in fetch.
243 * Revision 1.9 1995/10/02 15:18:52 adam
244 * New member in recRetrieveCtrl: diagnostic.
246 * Revision 1.8 1995/09/28 09:19:47 adam
247 * xfree/xmalloc used everywhere.
248 * Extract/retrieve method seems to work for text records.
250 * Revision 1.7 1995/09/27 16:17:32 adam
251 * More work on retrieve.
253 * Revision 1.6 1995/09/08 08:53:22 adam
254 * Record buffer maintained in server_info.
256 * Revision 1.5 1995/09/06 16:11:18 adam
257 * Option: only one word key per file.
259 * Revision 1.4 1995/09/06 10:33:04 adam
260 * More work on present. Some log messages removed.
262 * Revision 1.3 1995/09/05 15:28:40 adam
263 * More work on search engine.
265 * Revision 1.2 1995/09/04 12:33:43 adam
266 * Various cleanup. YAZ util used instead.
268 * Revision 1.1 1995/09/04 09:10:41 adam
269 * More work on index add/del/update.
270 * Merge sort implemented.
271 * Initial work on z39 server.
285 #include <yaz/data1.h>
296 #include "zebrasdr.h"
299 static int bend_sort (void *handle, bend_sort_rr *rr);
300 static int bend_delete (void *handle, bend_delete_rr *rr);
301 static int bend_esrequest (void *handle, bend_esrequest_rr *rr);
302 static int bend_segment (void *handle, bend_segment_rr *rr);
304 bend_initresult *bend_init (bend_initrequest *q)
306 bend_initresult *r = (bend_initresult *)
307 odr_malloc (q->stream, sizeof(*r));
309 struct statserv_options_block *sob;
315 q->bend_sort = bend_sort;
316 q->bend_delete = bend_delete;
317 q->bend_esrequest = bend_esrequest;
318 q->bend_segment = bend_segment;
320 q->implementation_name = "Z'mbol Information Server";
321 q->implementation_version = "Z'mbol 1.0";
323 logf (LOG_DEBUG, "bend_init");
325 sob = statserv_getcontrol ();
326 if (!(zh = zebra_open (sob->handle)))
328 logf (LOG_FATAL, "Failed to open Zebra `%s'", sob->configname);
334 if (q->auth->which == Z_IdAuthentication_open)
336 char *openpass = xstrdup (q->auth->u.open);
337 char *cp = strchr (openpass, '/');
341 user = nmem_strdup (odr_getmem (q->stream), openpass);
342 passwd = nmem_strdup (odr_getmem (q->stream), cp+1);
347 if (zebra_auth (zh->service, user, passwd))
358 bend_searchresult *bend_search (void *handle, bend_searchrequest *q, int *fd)
360 ZebraHandle zh = (ZebraHandle) handle;
361 bend_searchresult *r = (bend_searchresult *)
362 odr_malloc (q->stream, sizeof(*r));
368 logf (LOG_LOG, "ResultSet '%s'", q->setname);
369 switch (q->query->which)
371 case Z_Query_type_1: case Z_Query_type_101:
372 zebra_search_rpn (zh, q->decode, q->stream, q->query->u.type_1,
373 q->num_bases, q->basenames, q->setname);
374 r->errcode = zh->errCode;
375 r->errstring = zh->errString;
380 r->errstring = "type-2";
388 bend_fetchresult *bend_fetch (void *handle, bend_fetchrequest *q, int *num)
390 ZebraHandle zh = (ZebraHandle) handle;
391 bend_fetchresult *r = (bend_fetchresult *)
392 odr_malloc (q->stream, sizeof(*r));
393 ZebraRetrievalRecord retrievalRecord;
395 retrievalRecord.position = q->number;
398 zebra_records_retrieve (zh, q->stream, q->setname, q->comp,
399 q->format, 1, &retrievalRecord);
400 if (zh->errCode) /* non Surrogate Diagnostic */
402 r->errcode = zh->errCode;
403 r->errstring = zh->errString;
405 else if (retrievalRecord.errCode) /* Surrogate Diagnostic */
407 q->surrogate_flag = 1;
408 r->errcode = retrievalRecord.errCode;
409 r->errstring = retrievalRecord.errString;
410 r->basename = retrievalRecord.base;
412 else /* Database Record */
415 r->basename = retrievalRecord.base;
416 r->record = retrievalRecord.buf;
417 r->len = retrievalRecord.len;
418 r->format = retrievalRecord.format;
423 bend_scanresult *bend_scan (void *handle, bend_scanrequest *q, int *num)
425 ZebraScanEntry *entries;
426 ZebraHandle zh = (ZebraHandle) handle;
427 bend_scanresult *r = (bend_scanresult *)
428 odr_malloc (q->stream, sizeof(*r));
431 r->term_position = q->term_position;
432 r->num_entries = q->num_entries;
434 r->entries = (struct scan_entry *)
435 odr_malloc (q->stream, sizeof(*r->entries) * q->num_entries);
436 zebra_scan (zh, q->stream, q->term,
438 q->num_bases, q->basenames,
440 &r->num_entries, &entries, &is_partial);
442 r->status = BEND_SCAN_PARTIAL;
444 r->status = BEND_SCAN_SUCCESS;
445 for (i = 0; i < r->num_entries; i++)
447 r->entries[i].term = entries[i].term;
448 r->entries[i].occurrences = entries[i].occurrences;
450 r->errcode = zh->errCode;
451 r->errstring = zh->errString;
455 void bend_close (void *handle)
457 zebra_close ((ZebraHandle) handle);
460 int bend_sort (void *handle, bend_sort_rr *rr)
462 ZebraHandle zh = (ZebraHandle) handle;
464 zebra_sort (zh, rr->stream,
465 rr->num_input_setnames, (const char **) rr->input_setnames,
466 rr->output_setname, rr->sort_sequence, &rr->sort_status);
467 rr->errcode = zh->errCode;
468 rr->errstring = zh->errString;
472 int bend_delete (void *handle, bend_delete_rr *rr)
474 ZebraHandle zh = (ZebraHandle) handle;
476 rr->delete_status = zebra_deleleResultSet(zh, rr->function,
477 rr->num_setnames, rr->setnames,
482 static int es_admin_request (ZebraHandle zh, Z_AdminEsRequest *r)
484 switch (r->toKeep->which)
486 case Z_ESAdminOriginPartToKeep_reIndex:
487 yaz_log(LOG_LOG, "adm-reindex");
489 case Z_ESAdminOriginPartToKeep_truncate:
490 yaz_log(LOG_LOG, "adm-truncate");
492 case Z_ESAdminOriginPartToKeep_delete:
493 yaz_log(LOG_LOG, "adm-delete");
495 case Z_ESAdminOriginPartToKeep_create:
496 yaz_log(LOG_LOG, "adm-create");
497 zebra_admin_create (zh, r->toKeep->databaseName);
499 case Z_ESAdminOriginPartToKeep_import:
500 yaz_log(LOG_LOG, "adm-import");
502 case Z_ESAdminOriginPartToKeep_refresh:
503 yaz_log(LOG_LOG, "adm-refresh");
505 case Z_ESAdminOriginPartToKeep_commit:
506 yaz_log(LOG_LOG, "adm-commit");
508 case Z_ESAdminOriginPartToKeep_shutdown:
509 yaz_log(LOG_LOG, "shutdown");
510 zebra_admin_shutdown(zh);
512 case Z_ESAdminOriginPartToKeep_start:
513 yaz_log(LOG_LOG, "start");
514 zebra_admin_start(zh);
517 yaz_log(LOG_LOG, "unknown admin");
520 if (r->toKeep->databaseName)
522 yaz_log(LOG_LOG, "database %s", r->toKeep->databaseName);
527 static int es_admin (ZebraHandle zh, Z_Admin *r)
531 case Z_Admin_esRequest:
532 es_admin_request (zh, r->u.esRequest);
534 case Z_Admin_taskPackage:
535 yaz_log (LOG_LOG, "adm taskpackage (unhandled)");
545 int bend_segment (void *handle, bend_segment_rr *rr)
547 ZebraHandle zh = (ZebraHandle) handle;
549 zebra_admin_import_segment (zh, rr->segment);
553 int bend_esrequest (void *handle, bend_esrequest_rr *rr)
555 ZebraHandle zh = (ZebraHandle) handle;
557 yaz_log(LOG_LOG, "function: %d", *rr->esr->function);
558 if (rr->esr->packageName)
559 yaz_log(LOG_LOG, "packagename: %s", rr->esr->packageName);
560 yaz_log(LOG_LOG, "Waitaction: %d", *rr->esr->waitAction);
562 if (!rr->esr->taskSpecificParameters)
564 yaz_log (LOG_WARN, "No task specific parameters");
566 else if (rr->esr->taskSpecificParameters->which == Z_External_ESAdmin)
568 es_admin (zh, rr->esr->taskSpecificParameters->u.adminService);
569 rr->errcode = zh->errCode;
570 rr->errstring = zh->errString;
572 else if (rr->esr->taskSpecificParameters->which == Z_External_itemOrder)
574 Z_ItemOrder *it = rr->esr->taskSpecificParameters->u.itemOrder;
575 yaz_log (LOG_LOG, "Received ItemOrder");
579 case Z_IOItemOrder_esRequest:
581 case Z_ItemOrder_esRequest:
584 Z_IORequest *ir = it->u.esRequest;
585 Z_IOOriginPartToKeep *k = ir->toKeep;
586 Z_IOOriginPartNotToKeep *n = ir->notToKeep;
590 if (k->contact->name)
591 yaz_log(LOG_LOG, "contact name %s", k->contact->name);
592 if (k->contact->phone)
593 yaz_log(LOG_LOG, "contact phone %s", k->contact->phone);
594 if (k->contact->email)
595 yaz_log(LOG_LOG, "contact email %s", k->contact->email);
599 yaz_log(LOG_LOG, "Billing info (not shown)");
602 if (n->resultSetItem)
604 yaz_log(LOG_LOG, "resultsetItem");
605 yaz_log(LOG_LOG, "setId: %s", n->resultSetItem->resultSetId);
606 yaz_log(LOG_LOG, "item: %d", *n->resultSetItem->item);
611 Z_External *r = (Z_External*) n->itemRequest;
612 ILL_ItemRequest *item_req = 0;
613 ILL_Request *ill_req = 0;
614 if (r->direct_reference)
616 oident *ent = oid_getentbyoid(r->direct_reference);
618 yaz_log(LOG_LOG, "OID %s", ent->desc);
619 if (ent && ent->value == VAL_ISO_ILL_1)
621 yaz_log (LOG_LOG, "ItemRequest");
622 if (r->which == ODR_EXTERNAL_single)
624 odr_setbuf(rr->decode,
625 r->u.single_ASN1_type->buf,
626 r->u.single_ASN1_type->len, 0);
628 if (!ill_ItemRequest (rr->decode, &item_req, 0, 0))
631 "Couldn't decode ItemRequest %s near %d",
632 odr_errmsg(odr_geterror(rr->decode)),
633 odr_offset(rr->decode));
634 yaz_log(LOG_LOG, "PDU dump:");
635 odr_dumpBER(log_file(),
636 r->u.single_ASN1_type->buf,
637 r->u.single_ASN1_type->len);
641 ill_ItemRequest (rr->print, &item_req, 0,
643 odr_reset (rr->print);
646 if (!item_req && r->which == ODR_EXTERNAL_single)
648 yaz_log (LOG_LOG, "ILLRequest");
649 odr_setbuf(rr->decode,
650 r->u.single_ASN1_type->buf,
651 r->u.single_ASN1_type->len, 0);
653 if (!ill_Request (rr->decode, &ill_req, 0, 0))
656 "Couldn't decode ILLRequest %s near %d",
657 odr_errmsg(odr_geterror(rr->decode)),
658 odr_offset(rr->decode));
659 yaz_log(LOG_LOG, "PDU dump:");
660 odr_dumpBER(log_file(),
661 r->u.single_ASN1_type->buf,
662 r->u.single_ASN1_type->len);
666 ill_Request (rr->print, &ill_req, 0,
668 odr_reset (rr->print);
675 yaz_log (LOG_LOG, "ILL protocol version = %d",
676 *item_req->protocol_version_num);
684 else if (rr->esr->taskSpecificParameters->which == Z_External_update)
686 Z_IUUpdate *up = rr->esr->taskSpecificParameters->u.update;
687 yaz_log (LOG_LOG, "Received DB Update");
688 if (up->which == Z_IUUpdate_esRequest)
690 Z_IUUpdateEsRequest *esRequest = up->u.esRequest;
691 Z_IUOriginPartToKeep *toKeep = esRequest->toKeep;
692 Z_IUSuppliedRecords *notToKeep = esRequest->notToKeep;
694 yaz_log (LOG_LOG, "action");
697 switch (*toKeep->action)
699 case Z_IUOriginPartToKeep_recordInsert:
700 yaz_log (LOG_LOG, "recordInsert");
702 case Z_IUOriginPartToKeep_recordReplace:
703 yaz_log (LOG_LOG, "recordUpdate");
705 case Z_IUOriginPartToKeep_recordDelete:
706 yaz_log (LOG_LOG, "recordDelete");
708 case Z_IUOriginPartToKeep_elementUpdate:
709 yaz_log (LOG_LOG, "elementUpdate");
711 case Z_IUOriginPartToKeep_specialUpdate:
712 yaz_log (LOG_LOG, "specialUpdate");
714 case Z_ESAdminOriginPartToKeep_shutdown:
715 yaz_log (LOG_LOG, "shutDown");
717 case Z_ESAdminOriginPartToKeep_start:
718 yaz_log (LOG_LOG, "start");
721 yaz_log (LOG_LOG, " unknown (%d)", *toKeep->action);
724 if (toKeep->databaseName)
726 yaz_log (LOG_LOG, "database: %s", toKeep->databaseName);
727 if (!strcmp(toKeep->databaseName, "fault"))
730 rr->errstring = toKeep->databaseName;
732 if (!strcmp(toKeep->databaseName, "accept"))
738 for (i = 0; i < notToKeep->num; i++)
740 Z_External *rec = notToKeep->elements[i]->record;
742 if (rec->direct_reference)
744 struct oident *oident;
745 oident = oid_getentbyoid(rec->direct_reference);
747 yaz_log (LOG_LOG, "record %d type %s", i,
752 case Z_External_sutrs:
753 if (rec->u.octet_aligned->len > 170)
754 yaz_log (LOG_LOG, "%d bytes:\n%.168s ...",
758 yaz_log (LOG_LOG, "%d bytes:\n%s",
762 case Z_External_octet :
763 if (rec->u.octet_aligned->len > 170)
764 yaz_log (LOG_LOG, "%d bytes:\n%.168s ...",
765 rec->u.octet_aligned->len,
766 rec->u.octet_aligned->buf);
768 yaz_log (LOG_LOG, "%d bytes\n%s",
769 rec->u.octet_aligned->len,
770 rec->u.octet_aligned->buf);
778 yaz_log (LOG_WARN, "Unknown Extended Service(%d)",
779 rr->esr->taskSpecificParameters->which);
785 static void bend_start (struct statserv_options_block *sob)
792 char *pidfile = "zebrasrv.pid";
793 int fd = creat (pidfile, 0666);
795 logf (LOG_WARN|LOG_ERRNO, "creat %s", pidfile);
800 sprintf (pidstr, "%ld", (long) getpid ());
801 write (fd, pidstr, strlen(pidstr));
807 zebra_stop((ZebraService) sob->handle);
808 sob->handle = zebra_start(sob->configname);
811 static void bend_stop(struct statserv_options_block *sob)
815 ZebraService service = sob->handle;
820 int main (int argc, char **argv)
822 struct statserv_options_block *sob;
824 sob = statserv_getcontrol ();
825 strcpy (sob->configname, FNAME_CONFIG);
826 sob->bend_start = bend_start;
827 sob->bend_stop = bend_stop;
834 statserv_setcontrol (sob);
836 return statserv_main (argc, argv);